Group¶

class oci.identity.models.Group(**kwargs)¶

Bases: object

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 IAM.

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. 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 Get Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Group.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Group.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Group.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Group.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a Group.
`compartment_id`	[Required] Gets the compartment_id of this Group.
`defined_tags`	Gets the defined_tags of this Group.
`description`	[Required] Gets the description of this Group.
`freeform_tags`	Gets the freeform_tags of this Group.
`id`	[Required] Gets the id of this Group.
`inactive_status`	Gets the inactive_status of this Group.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Group.
`name`	[Required] Gets the name of this Group.
`time_created`	[Required] Gets the time_created of this Group.

Methods

__init__(**kwargs) Initializes a new Group object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Group. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Group. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Group. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Group. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a Group. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new Group object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this Group.
compartment_id (str) – The value to assign to the compartment_id property of this Group.
name (str) – The value to assign to the name property of this Group.
description (str) – The value to assign to the description property of this Group.
time_created (datetime) – The value to assign to the time_created property of this Group.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Group. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this Group.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Group.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Group.

compartment_id¶

[Required] Gets the compartment_id of this Group. The OCID of the tenancy containing the group.

Returns:	The compartment_id of this Group.
Return type:	str

defined_tags¶

Gets the defined_tags of this Group. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this Group.
Return type:	dict(str, dict(str, object))

description¶

[Required] Gets the description of this Group. The description you assign to the group. Does not have to be unique, and it’s changeable.

(For tenancies that support identity domains) You can have an empty description.

Returns:	The description of this Group.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this Group. 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. Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this Group.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Group. The OCID of the group.

Returns:	The id of this Group.
Return type:	str

inactive_status¶

Gets the inactive_status of this Group. The detailed status of INACTIVE lifecycleState.

Returns:	The inactive_status of this Group.
Return type:	int

lifecycle_state¶

[Required] Gets the lifecycle_state of this Group. The group’s current state. After creating a group, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this Group.
Return type:	str

name¶

[Required] Gets the name of this Group. The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.

Returns:	The name of this Group.
Return type:	str

time_created¶

[Required] Gets the time_created of this Group. Date and time the group was created, in the format defined by RFC3339.

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

Returns:	The time_created of this Group.
Return type:	datetime