Class: OCI::Identity::Models::IdpGroupMapping
- Inherits:
-
Object
- Object
- OCI::Identity::Models::IdpGroupMapping
- 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.
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'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the tenancy containing the
IdentityProvider
. -
#group_id ⇒ String
[Required] The OCID of the IAM Service group that is mapped to the IdP group.
-
#id ⇒ String
[Required] The OCID of the
IdpGroupMapping
. -
#idp_group_name ⇒ String
[Required] The name of the IdP group that is mapped to the IAM Service group.
-
#idp_id ⇒ String
[Required] The OCID of the
IdentityProvider
this mapping belongs to. -
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
-
#lifecycle_state ⇒ String
[Required] The mapping's current state.
-
#time_created ⇒ DateTime
[Required] Date and time the mapping was created, in the format defined by RFC3339.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ IdpGroupMapping
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ IdpGroupMapping
Initializes the object
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 156 157 158 159 160 161 162 163 164 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 115 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.id = attributes[:'id'] if attributes[:'id'] self.idp_id = attributes[:'idpId'] if attributes[:'idpId'] raise 'You cannot provide both :idpId and :idp_id' if attributes.key?(:'idpId') && attributes.key?(:'idp_id') self.idp_id = attributes[:'idp_id'] if attributes[:'idp_id'] self.idp_group_name = attributes[:'idpGroupName'] if attributes[:'idpGroupName'] raise 'You cannot provide both :idpGroupName and :idp_group_name' if attributes.key?(:'idpGroupName') && attributes.key?(:'idp_group_name') self.idp_group_name = attributes[:'idp_group_name'] if attributes[:'idp_group_name'] self.group_id = attributes[:'groupId'] if attributes[:'groupId'] raise 'You cannot provide both :groupId and :group_id' if attributes.key?(:'groupId') && attributes.key?(:'group_id') self.group_id = attributes[:'group_id'] if attributes[:'group_id'] self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.inactive_status = attributes[:'inactiveStatus'] if attributes[:'inactiveStatus'] raise 'You cannot provide both :inactiveStatus and :inactive_status' if attributes.key?(:'inactiveStatus') && attributes.key?(:'inactive_status') self.inactive_status = attributes[:'inactive_status'] if attributes[:'inactive_status'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the tenancy containing the IdentityProvider
.
50 51 52 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 50 def compartment_id @compartment_id end |
#group_id ⇒ String
[Required] The OCID of the IAM Service group that is mapped to the IdP group.
46 47 48 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 46 def group_id @group_id end |
#id ⇒ String
[Required] The OCID of the IdpGroupMapping
.
34 35 36 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 34 def id @id end |
#idp_group_name ⇒ String
[Required] The name of the IdP group that is mapped to the IAM Service group.
42 43 44 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 42 def idp_group_name @idp_group_name end |
#idp_id ⇒ String
[Required] The OCID of the IdentityProvider
this mapping belongs to.
38 39 40 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 38 def idp_id @idp_id end |
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
67 68 69 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 67 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.
63 64 65 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 63 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
57 58 59 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 57 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 70 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'idp_id': :'idpId', 'idp_group_name': :'idpGroupName', 'group_id': :'groupId', 'compartment_id': :'compartmentId', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState', 'inactive_status': :'inactiveStatus' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 86 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'idp_id': :'String', 'idp_group_name': :'String', 'group_id': :'String', 'compartment_id': :'String', 'time_created': :'DateTime', 'lifecycle_state': :'String', 'inactive_status': :'Integer' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 186 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && idp_id == other.idp_id && idp_group_name == other.idp_group_name && group_id == other.group_id && compartment_id == other.compartment_id && time_created == other.time_created && lifecycle_state == other.lifecycle_state && inactive_status == other.inactive_status end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 223 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
203 204 205 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 203 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
212 213 214 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 212 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
256 257 258 259 260 261 262 263 264 265 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 256 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
250 251 252 |
# File 'lib/oci/identity/models/idp_group_mapping.rb', line 250 def to_s to_hash.to_s end |