Class: OCI::IdentityDomains::Models::AppUserAssertionAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/app_user_assertion_attributes.rb

Overview

Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion.

Deprecated Since: 18.2.2

SCIM++ Properties: - caseExact: false - idcsCompositeKey: [name] - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AppUserAssertionAttributes

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :user_store_attribute_name (String) —

    The value to assign to the #user_store_attribute_name property

  • :format (String) —

    The value to assign to the #format property



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 107

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.name = attributes[:'name'] if attributes[:'name']

  self.user_store_attribute_name = attributes[:'userStoreAttributeName'] if attributes[:'userStoreAttributeName']

  raise 'You cannot provide both :userStoreAttributeName and :user_store_attribute_name' if attributes.key?(:'userStoreAttributeName') && attributes.key?(:'user_store_attribute_name')

  self.user_store_attribute_name = attributes[:'user_store_attribute_name'] if attributes[:'user_store_attribute_name']

  self.format = attributes[:'format'] if attributes[:'format']
end

Instance Attribute Details

#format ⇒ String

Indicates the format of the assertion attribute.

Deprecated Since: 18.2.2

SCIM++ Properties: - caseExact: true - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 74

def format
  @format
end

#name ⇒ String

[Required] The attribute represents the name of the attribute that will be used in the Security Assertion Markup Language (SAML) assertion

Deprecated Since: 18.2.2

SCIM++ Properties: - caseExact: false - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 40

def name
  @name
end

#user_store_attribute_name ⇒ String

[Required] This attribute specifies which user attribute should be used to create the value of the SAML assertion attribute. The userstore attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.
Note: Attributes from extensions to the Core User schema are not supported in v1.0.

Deprecated Since: 18.2.2

SCIM++ Properties: - caseExact: false - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 57

def user_store_attribute_name
  @user_store_attribute_name
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'user_store_attribute_name': :'userStoreAttributeName',
    'format': :'format'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'user_store_attribute_name': :'String',
    'format': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



131
132
133
134
135
136
137
138
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 131

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    user_store_attribute_name == other.user_store_attribute_name &&
    format == other.format
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 163

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


143
144
145
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 152

def hash
  [name, user_store_attribute_name, format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 196

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



190
191
192
 
# File 'lib/oci/identity_domains/models/app_user_assertion_attributes.rb', line 190

def to_s
  to_hash.to_s
end