IdpGroupMapping¶
- class oci.identity.models.IdpGroupMapping(**kwargs)¶
Bases:
objectA mapping between a single group defined by the identity provider (IdP) you’re federating with and a single IAM Service
Groupin Oracle Cloud Infrastructure. For more information about group mappings and what they’re for, see Identity Providers and Federation.A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa. But each IdPGroupMapping object is between only a single IdP group and IAM Service group. Each IdPGroupMapping object has its own OCID.
Note: Any users who are in more than 50 IdP groups cannot be authenticated to use the Oracle Cloud Infrastructure Console.
Attributes:
A constant which can be used with the lifecycle_state property of a IdpGroupMapping.
A constant which can be used with the lifecycle_state property of a IdpGroupMapping.
A constant which can be used with the lifecycle_state property of a IdpGroupMapping.
A constant which can be used with the lifecycle_state property of a IdpGroupMapping.
A constant which can be used with the lifecycle_state property of a IdpGroupMapping.
[Required] Gets the compartment_id of this IdpGroupMapping.
[Required] Gets the group_id of this IdpGroupMapping.
[Required] Gets the id of this IdpGroupMapping.
[Required] Gets the idp_group_name of this IdpGroupMapping.
[Required] Gets the idp_id of this IdpGroupMapping.
Gets the inactive_status of this IdpGroupMapping.
[Required] Gets the lifecycle_state of this IdpGroupMapping.
[Required] Gets the time_created of this IdpGroupMapping.
Methods:
__init__(**kwargs)Initializes a new IdpGroupMapping object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a IdpGroupMapping. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a IdpGroupMapping. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a IdpGroupMapping. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a IdpGroupMapping. This constant has a value of “DELETING”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a IdpGroupMapping. This constant has a value of “INACTIVE”
- __init__(**kwargs)¶
Initializes a new IdpGroupMapping 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 IdpGroupMapping.
idp_id (str) – The value to assign to the idp_id property of this IdpGroupMapping.
idp_group_name (str) – The value to assign to the idp_group_name property of this IdpGroupMapping.
group_id (str) – The value to assign to the group_id property of this IdpGroupMapping.
compartment_id (str) – The value to assign to the compartment_id property of this IdpGroupMapping.
time_created (datetime) – The value to assign to the time_created property of this IdpGroupMapping.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IdpGroupMapping. 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 IdpGroupMapping.
- property compartment_id¶
[Required] Gets the compartment_id of this IdpGroupMapping. The OCID of the tenancy containing the IdentityProvider.
- Returns
The compartment_id of this IdpGroupMapping.
- Return type
str
- property group_id¶
[Required] Gets the group_id of this IdpGroupMapping. The OCID of the IAM Service group that is mapped to the IdP group.
- Returns
The group_id of this IdpGroupMapping.
- Return type
str
- property id¶
[Required] Gets the id of this IdpGroupMapping. The OCID of the IdpGroupMapping.
- Returns
The id of this IdpGroupMapping.
- Return type
str
- property idp_group_name¶
[Required] Gets the idp_group_name of this IdpGroupMapping. The name of the IdP group that is mapped to the IAM Service group.
- Returns
The idp_group_name of this IdpGroupMapping.
- Return type
str
- property idp_id¶
[Required] Gets the idp_id of this IdpGroupMapping. The OCID of the IdentityProvider this mapping belongs to.
- Returns
The idp_id of this IdpGroupMapping.
- Return type
str
- property inactive_status¶
Gets the inactive_status of this IdpGroupMapping. The detailed status of INACTIVE lifecycleState.
- Returns
The inactive_status of this IdpGroupMapping.
- Return type
int
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this IdpGroupMapping. The mapping’s current state. After creating a mapping 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 IdpGroupMapping.
- Return type
str
- property time_created¶
[Required] Gets the time_created of this IdpGroupMapping. Date and time the mapping was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this IdpGroupMapping.
- Return type
datetime