• Public
  • Public/Protected
  • All

Module Group

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.

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](https://docs.cloud.oracle.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](https://docs.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).

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



compartmentId: string

The OCID of the tenancy containing the group.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}


description: string

The description you assign to the group. Does not have to be unique, and it's changeable.

Optional freeformTags

freeformTags: undefined | object

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\"}


id: string

The OCID of the group.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState.


lifecycleState: LifecycleState

The group's current state. After creating a group, make sure its lifecycleState changes from CREATING to ACTIVE before using it.


name: string

The name you assign to the group during creation. The name must be unique across all groups in the tenancy and cannot be changed.


timeCreated: Date

Date and time the group was created, in the format defined by RFC3339.

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



  • getJsonObj(obj: Group): object