Class: OCI::Identity::Models::IdpGroupMapping

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

Overview

A mapping between a single group defined by the identity provider (IdP) you’re federating with and a single IAM Service Group in Oracle Cloud Infrastructure. For more information about group mappings and what they’re for, see [Identity Providers and Federation](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm).

A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. But each ‘IdPGroupMapping` object is between only a single IdP group and IAM Service group. Each `IdPGroupMapping` object has its own OCID.

Note: Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle Cloud Infrastructure Console.

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

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdpGroupMapping

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

  • :idp_id (String) —

    The value to assign to the #idp_id property

  • :idp_group_name (String) —

    The value to assign to the #idp_group_name property

  • :group_id (String) —

    The value to assign to the #group_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :inactive_status (Integer) —

    The value to assign to the #inactive_status property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
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
152
153
154
155
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 75

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[:'idpId']
    self.idp_id = attributes[:'idpId']
  end

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

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

  if attributes[:'idpGroupName']
    self.idp_group_name = attributes[:'idpGroupName']
  end

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

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

  if attributes[:'groupId']
    self.group_id = attributes[:'groupId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 45

def compartment_id
  @compartment_id
end

#group_id ⇒ String

[Required] The OCID of the IAM Service group that is mapped to the IdP group.

Returns:

  • (String) 


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

def group_id
  @group_id
end

#id ⇒ String

[Required] The OCID of the ‘IdpGroupMapping`.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 29

def id
  @id
end

#idp_group_name ⇒ String

[Required] The name of the IdP group that is mapped to the IAM Service group.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 37

def idp_group_name
  @idp_group_name
end

#idp_id ⇒ String

[Required] The OCID of the ‘IdentityProvider` this mapping belongs to.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 33

def idp_id
  @idp_id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


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

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

[Required] The mapping’s current state. After creating a mapping object, make sure its ‘lifecycleState` changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 52

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 169

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      idp_id == other_object.idp_id &&
      idp_group_name == other_object.idp_group_name &&
      group_id == other_object.group_id &&
      compartment_id == other_object.compartment_id &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status
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



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

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


184
185
186
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 184

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 190

def hash
  [id, idp_id, idp_group_name, group_id, compartment_id, time_created, lifecycle_state, inactive_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



216
217
218
 
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 216

def to_s
  to_hash.to_s
end