Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UserGroupMembership

An object that represents the membership of a user in a group. When you add a user to a group, the result is a {@code UserGroupMembership} with its own OCID. To remove a user from a group, you delete the {@code UserGroupMembership} object.

Properties

compartmentId

compartmentId: string

The OCID of the tenancy containing the user, group, and membership object.

groupId

groupId: string

The OCID of the group.

id

id: string

The OCID of the membership.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

lifecycleState

lifecycleState: LifecycleState

The membership's current state. After creating a membership object, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

timeCreated

timeCreated: Date

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

Example: {@code 2016-08-25T21:10:29.600Z}

userId

userId: string

The OCID of the user.

Functions

getDeserializedJsonObj

getJsonObj