Class: OCI::Identity::Models::Group
- Inherits:
-
Object
- Object
- OCI::Identity::Models::Group
- Defined in:
- lib/oci/identity/models/group.rb
Overview
A collection of users who all need the same type of access to a particular set of resources or compartment. For conceptual information about groups and other IAM Service components, see [Overview of the IAM Service](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/overview.htm).
If you’re federating with an identity provider (IdP), you need to create mappings between the groups defined in the IdP and groups you define in the IAM service. For more information, see [Identity Providers and Federation](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/federation.htm). Also see IdentityProvider and IdpGroupMapping.
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).
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
-
#compartment_id ⇒ String
[Required] The OCID of the tenancy containing the group.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
[Required] The description you assign to the group.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the group.
-
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
-
#lifecycle_state ⇒ String
[Required] The group’s current state.
-
#name ⇒ String
[Required] The name you assign to the group during creation.
-
#time_created ⇒ DateTime
[Required] Date and time the group was created, in the format defined by RFC3339.
Instance Method Summary collapse
-
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other_object) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Group
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 = {}) ⇒ Group
Initializes the object
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 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/oci/identity/models/group.rb', line 90 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 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[:'name'] self.name = attributes[:'name'] end if attributes[:'description'] self.description = attributes[:'description'] 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 if attributes[:'freeformTags'] self. = attributes[:'freeformTags'] end raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') if attributes[:'freeform_tags'] self. = attributes[:'freeform_tags'] end if attributes[:'definedTags'] self. = attributes[:'definedTags'] end raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') if attributes[:'defined_tags'] self. = attributes[:'defined_tags'] end end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the tenancy containing the group.
35 36 37 |
# File 'lib/oci/identity/models/group.rb', line 35 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"}`
76 77 78 |
# File 'lib/oci/identity/models/group.rb', line 76 def end |
#description ⇒ String
[Required] The description you assign to the group. Does not have to be unique, and it’s changeable.
45 46 47 |
# File 'lib/oci/identity/models/group.rb', line 45 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"`
69 70 71 |
# File 'lib/oci/identity/models/group.rb', line 69 def end |
#id ⇒ String
[Required] The OCID of the group.
31 32 33 |
# File 'lib/oci/identity/models/group.rb', line 31 def id @id end |
#inactive_status ⇒ Integer
The detailed status of INACTIVE lifecycleState.
62 63 64 |
# File 'lib/oci/identity/models/group.rb', line 62 def inactive_status @inactive_status end |
#lifecycle_state ⇒ String
[Required] The group’s current state. After creating a group, make sure its ‘lifecycleState` changes from CREATING to ACTIVE before using it.
58 59 60 |
# File 'lib/oci/identity/models/group.rb', line 58 def lifecycle_state @lifecycle_state end |
#name ⇒ String
[Required] The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.
41 42 43 |
# File 'lib/oci/identity/models/group.rb', line 41 def name @name end |
#time_created ⇒ DateTime
[Required] Date and time the group was created, in the format defined by RFC3339.
Example: ‘2016-08-25T21:10:29.600Z`
52 53 54 |
# File 'lib/oci/identity/models/group.rb', line 52 def time_created @time_created end |
Instance Method Details
#==(other_object) ⇒ Object
Checks equality by comparing each attribute.
182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/oci/identity/models/group.rb', line 182 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 && time_created == other_object.time_created && lifecycle_state == other_object.lifecycle_state && inactive_status == other_object.inactive_status && == other_object. && == other_object. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/oci/identity/models/group.rb', line 211 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
198 199 200 |
# File 'lib/oci/identity/models/group.rb', line 198 def eql?(other_object) self == other_object end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
204 205 206 |
# File 'lib/oci/identity/models/group.rb', line 204 def hash [id, compartment_id, name, description, time_created, lifecycle_state, inactive_status, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
236 237 238 239 240 241 242 243 244 |
# File 'lib/oci/identity/models/group.rb', line 236 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
230 231 232 |
# File 'lib/oci/identity/models/group.rb', line 230 def to_s to_hash.to_s end |