Skip to main content

idp_group_mappings

Creates, updates, deletes, gets or lists an idp_group_mappings resource.

Overview​

Nameidp_group_mappings
TypeResource
Idoci.identity.idp_group_mappings

Fields​

The following fields are returned by SELECT queries:

The mapping is being retrieved.

NameDatatypeDescription
idstringThe OCID of the IdpGroupMapping.
compartmentIdstringThe OCID of the tenancy containing the IdentityProvider.
groupIdstringThe OCID of the IAM Service group that is mapped to the IdP group.
idpGroupNamestringThe name of the IdP group that is mapped to the IAM Service group.
idpIdstringThe OCID of the IdentityProvider this mapping belongs to.
inactiveStatusinteger (int64)The detailed status of INACTIVE lifecycleState.
lifecycleStatestringThe mapping's current state. After creating a mapping object, make sure its lifecycleState changes from CREATING to ACTIVE before using it. (CREATING, ACTIVE, INACTIVE, DELETING, DELETED)
timeCreatedstring (date-time)Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectidentityProviderId, mappingId, regionDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Gets the specified group mapping.<br />
listselectidentityProviderId, regionpage, limitDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Lists the group mappings for the specified identity provider.<br />
createinsertidentityProviderId, region, idpGroupName, groupIdopc-retry-tokenDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Creates a single mapping between an IdP group and an IAM Service<br />[group](#/en/identity/20160918/Group/).<br />
updateupdateidentityProviderId, mappingId, regionif-matchDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Updates the specified group mapping.<br />
deletedeleteidentityProviderId, mappingId, regionif-matchDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Deletes the specified group mapping.<br />

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
identityProviderIdstringThe OCID of the identity provider.
mappingIdstringThe OCID of the group mapping.
regionstringOCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
if-matchstringFor optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
limitintegerThe maximum number of items to return in a paginated "List" call.
opc-retry-tokenstringA token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
pagestringThe value of the opc-next-page response header from the previous "List" call.

SELECT examples​

Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Gets the specified group mapping.<br />

SELECT
id,
compartmentId,
groupId,
idpGroupName,
idpId,
inactiveStatus,
lifecycleState,
timeCreated
FROM oci.identity.idp_group_mappings
WHERE identityProviderId = '{{ identityProviderId }}' -- required
AND mappingId = '{{ mappingId }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples​

Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Creates a single mapping between an IdP group and an IAM Service<br />[group](#/en/identity/20160918/Group/).<br />

INSERT INTO oci.identity.idp_group_mappings (
groupId,
idpGroupName,
identityProviderId,
region,
opc-retry-token
)
SELECT 
'{{ groupId }}' /* required */,
'{{ idpGroupName }}' /* required */,
'{{ identityProviderId }}',
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
groupId,
idpGroupName,
idpId,
inactiveStatus,
lifecycleState,
timeCreated
;

UPDATE examples​

Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Updates the specified group mapping.<br />

UPDATE oci.identity.idp_group_mappings
SET 
groupId = '{{ groupId }}',
idpGroupName = '{{ idpGroupName }}'
WHERE 
identityProviderId = '{{ identityProviderId }}' --required
AND mappingId = '{{ mappingId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
groupId,
idpGroupName,
idpId,
inactiveStatus,
lifecycleState,
timeCreated;

DELETE examples​

Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Deletes the specified group mapping.<br />

DELETE FROM oci.identity.idp_group_mappings
WHERE identityProviderId = '{{ identityProviderId }}' --required
AND mappingId = '{{ mappingId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;