Class: OCI::Identity::Models::IdentityProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/identity_provider.rb

Direct Known Subclasses

Saml2IdentityProvider

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_INACTIVE = 'INACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentityProvider

Initializes the object

Parameters:

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

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/identity/models/identity_provider.rb', line 101

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}

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

  if attributes[:'productType']
    self.product_type = attributes[:'productType']
  end

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end

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

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the tenancy containing the ‘IdentityProvider`.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/identity/models/identity_provider.rb', line 21

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: ‘{"bar-key": "foo-value"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


85
86
87
 
# File 'lib/oci/identity/models/identity_provider.rb', line 85

def defined_tags
  @defined_tags
end

#description ⇒ String

The description you assign to the ‘IdentityProvider` during creation. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/identity/models/identity_provider.rb', line 36

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: ‘"value"`

Returns:

  • (Hash<String, String>) 


79
80
81
 
# File 'lib/oci/identity/models/identity_provider.rb', line 79

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the ‘IdentityProvider`.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity/models/identity_provider.rb', line 17

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


66
67
68
 
# File 'lib/oci/identity/models/identity_provider.rb', line 66

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

The current state. After creating an ‘IdentityProvider`, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/identity/models/identity_provider.rb', line 62

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The name you assign to the ‘IdentityProvider` during creation. The name must be unique across all `IdentityProvider` objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/identity/models/identity_provider.rb', line 30

def name
  @name
end

#product_type ⇒ String

The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).

Allowed values are:

  • ‘ADFS`

  • ‘IDCS`

Example: ‘IDCS`

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/identity/models/identity_provider.rb', line 49

def product_type
  @product_type
end

#protocol ⇒ String

The protocol used for federation. Allowed value: ‘SAML2`.

Example: ‘SAML2`

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/identity/models/identity_provider.rb', line 73

def protocol
  @protocol
end

#time_created ⇒ DateTime

Date and time the ‘IdentityProvider` was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/identity/models/identity_provider.rb', line 56

def time_created
  @time_created
end

Class Method Details

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



90
91
92
93
94
95
96
97
 
# File 'lib/oci/identity/models/identity_provider.rb', line 90

def self.get_subtype(object_hash)
  type = object_hash[:'protocol']

  return 'OCI::Identity::Models::Saml2IdentityProvider' if type == 'SAML2'

  # TODO: Log a warning when the subtype is not found.
  return 'OCI::Identity::Models::IdentityProvider'
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/identity/models/identity_provider.rb', line 165

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      description == other_object.description &&
      product_type == other_object.product_type &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status &&
      protocol == other_object.protocol &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_tags
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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/oci/identity/models/identity_provider.rb', line 196

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/oci/identity/models/identity_provider.rb', line 183

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/oci/identity/models/identity_provider.rb', line 189

def hash
  [id, compartment_id, name, description, product_type, time_created, lifecycle_state, inactive_status, protocol, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/identity/models/identity_provider.rb', line 221

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



215
216
217
 
# File 'lib/oci/identity/models/identity_provider.rb', line 215

def to_s
  to_hash.to_s
end