class OCI::Identity::Models::IdpGroupMapping
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.cloud.oracle.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.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The OCID of the tenancy containing the `IdentityProvider`. @return [String]
[Required] The OCID of the IAM Service group that is mapped to the IdP group. @return [String]
[Required] The OCID of the `IdpGroupMapping`. @return [String]
[Required] The name of the IdP group that is mapped to the IAM Service group. @return [String]
[Required] The OCID of the `IdentityProvider` this mapping belongs to. @return [String]
The detailed status of INACTIVE lifecycleState. @return [Integer]
[Required] The mapping's current state. After creating a mapping object, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.
@return [String]
[Required] Date and time the mapping was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/identity/models/idp_group_mapping.rb, line 69 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :idp_id The value to assign to the {#idp_id} property @option attributes [String] :idp_group_name The value to assign to the {#idp_group_name} property @option attributes [String] :group_id The value to assign to the {#group_id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [Integer] :inactive_status The value to assign to the {#inactive_status} property
# File lib/oci/identity/models/idp_group_mapping.rb, line 114 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
Attribute type mapping.
# File lib/oci/identity/models/idp_group_mapping.rb, line 85 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/identity/models/idp_group_mapping.rb, line 185 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/identity/models/idp_group_mapping.rb, line 222 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/identity/models/idp_group_mapping.rb, line 202 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/identity/models/idp_group_mapping.rb, line 211 def hash [id, idp_id, idp_group_name, group_id, compartment_id, time_created, lifecycle_state, inactive_status].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/identity/models/idp_group_mapping.rb, line 169 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/identity/models/idp_group_mapping.rb, line 255 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/identity/models/idp_group_mapping.rb, line 249 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/identity/models/idp_group_mapping.rb, line 272 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end