identity_provider_groups
Creates, updates, deletes, gets or lists an identity_provider_groups resource.
Overview​
| Name | identity_provider_groups |
| Type | Resource |
| Id | oci.identity.identity_provider_groups |
Fields​
The following fields are returned by SELECT queries:
- list
A group created in an identity provider that can be mapped to a group in OCI<br />
| Name | Datatype | Description |
|---|---|---|
id | string | The OCID of the IdentityProviderGroup. |
name | string | Display name of the group |
displayName | string | Display name of the group |
externalIdentifier | string | Identifier of the group in the identity provider |
identityProviderId | string | The OCID of the IdentityProvider this group belongs to. |
timeCreated | string (date-time) | Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
timeModified | string (date-time) | Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | identityProviderId, region | page, limit, name, lifecycleState | Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Lists the identity provider groups.<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.
| Name | Datatype | Description |
|---|---|---|
identityProviderId | string | The OCID of the identity provider. |
region | string | OCI 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) |
lifecycleState | string | A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. |
limit | integer | The maximum number of items to return in a paginated "List" call. |
name | string | A filter to only return resources that match the given name exactly. |
page | string | The value of the opc-next-page response header from the previous "List" call. |
SELECT examples​
- list
Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Lists the identity provider groups.<br />
SELECT
id,
name,
displayName,
externalIdentifier,
identityProviderId,
timeCreated,
timeModified
FROM oci.identity.identity_provider_groups
WHERE identityProviderId = '{{ identityProviderId }}' -- required
AND region = '{{ region }}' -- required
AND page = '{{ page }}'
AND limit = '{{ limit }}'
AND name = '{{ name }}'
AND lifecycleState = '{{ lifecycleState }}'
;