UserGroupMembership¶

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

Bases: object

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

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a UserGroupMembership.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a UserGroupMembership.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a UserGroupMembership.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a UserGroupMembership.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a UserGroupMembership.
`compartment_id`	[Required] Gets the compartment_id of this UserGroupMembership.
`group_id`	[Required] Gets the group_id of this UserGroupMembership.
`id`	[Required] Gets the id of this UserGroupMembership.
`inactive_status`	Gets the inactive_status of this UserGroupMembership.
`lifecycle_state`	[Required] Gets the lifecycle_state of this UserGroupMembership.
`time_created`	[Required] Gets the time_created of this UserGroupMembership.
`user_id`	[Required] Gets the user_id of this UserGroupMembership.

Methods

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new UserGroupMembership 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 UserGroupMembership.
compartment_id (str) – The value to assign to the compartment_id property of this UserGroupMembership.
group_id (str) – The value to assign to the group_id property of this UserGroupMembership.
user_id (str) – The value to assign to the user_id property of this UserGroupMembership.
time_created (datetime) – The value to assign to the time_created property of this UserGroupMembership.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this UserGroupMembership. 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 UserGroupMembership.

compartment_id¶

[Required] Gets the compartment_id of this UserGroupMembership. The OCID of the tenancy containing the user, group, and membership object.

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

group_id¶

[Required] Gets the group_id of this UserGroupMembership. The OCID of the group.

Returns:	The group_id of this UserGroupMembership.
Return type:	str

id¶

[Required] Gets the id of this UserGroupMembership. The OCID of the membership.

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

inactive_status¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this UserGroupMembership. The membership’s current state. After creating a membership object, 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 UserGroupMembership.
Return type:	str

time_created¶

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

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

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

user_id¶

[Required] Gets the user_id of this UserGroupMembership. The OCID of the user.

Returns:	The user_id of this UserGroupMembership.
Return type:	str