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

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

Overview

The resulting base object when you add an identity provider to your tenancy. A Saml2IdentityProvider is a specific type of ‘IdentityProvider` that supports the SAML 2.0 protocol. Each `IdentityProvider` object has its own OCID. For more information, see [Identity Providers and Federation](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see [Getting Started with Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

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

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartmentId (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :productType (String) —

    The value to assign to the #product_type property

  • :timeCreated (DateTime) —

    The value to assign to the #time_created property

  • :lifecycleState (String) —

    The value to assign to the #lifecycle_state property

  • :inactiveStatus (Integer) —

    The value to assign to the #inactive_status property

  • :protocol (String) —

    The value to assign to the #protocol property

  • :freeformTags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :definedTags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/identity/models/identity_provider.rb', line 125

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

[Required] The OCID of the tenancy containing the ‘IdentityProvider`.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/identity/models/identity_provider.rb', line 32

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`

Returns:

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


98
99
100
 
# File 'lib/oci/identity/models/identity_provider.rb', line 98

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/identity/models/identity_provider.rb', line 47

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


91
92
93
 
# File 'lib/oci/identity/models/identity_provider.rb', line 91

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the ‘IdentityProvider`.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/identity/models/identity_provider.rb', line 28

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/identity/models/identity_provider.rb', line 77

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] 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) 


41
42
43
 
# File 'lib/oci/identity/models/identity_provider.rb', line 41

def name
  @name
end

#product_type ⇒ String

[Required] 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) 


60
61
62
 
# File 'lib/oci/identity/models/identity_provider.rb', line 60

def product_type
  @product_type
end

#protocol ⇒ String

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

Example: ‘SAML2`

Returns:

  • (String) 


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

def protocol
  @protocol
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


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

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.



103
104
105
106
107
108
109
110
 
# File 'lib/oci/identity/models/identity_provider.rb', line 103

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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/identity/models/identity_provider.rb', line 189

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/oci/identity/models/identity_provider.rb', line 220

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


207
208
209
 
# File 'lib/oci/identity/models/identity_provider.rb', line 207

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



213
214
215
 
# File 'lib/oci/identity/models/identity_provider.rb', line 213

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



245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/identity/models/identity_provider.rb', line 245

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



239
240
241
 
# File 'lib/oci/identity/models/identity_provider.rb', line 239

def to_s
  to_hash.to_s
end