Skip to main content

identity_providers

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

Overview​

Nameidentity_providers
TypeResource
Idoci.identity.identity_providers

Fields​

The following fields are returned by SELECT queries:

The user was found.

NameDatatypeDescription
idstringThe OCID of the IdentityProvider.
namestringThe name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
compartmentIdstringThe OCID of the tenancy containing the IdentityProvider.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
descriptionstringThe description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
freeformTagsobjectFree-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
inactiveStatusinteger (int64)The detailed status of INACTIVE lifecycleState.
lifecycleStatestringThe current state. After creating an IdentityProvider, make sure its lifecycleState changes from CREATING to ACTIVE before using it. (CREATING, ACTIVE, INACTIVE, DELETING, DELETED)
productTypestringThe identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Allowed values are: - ADFS - IDCS Example: IDCS
protocolstringThe protocol used for federation. Allowed value: SAML2. Example: SAML2
timeCreatedstring (date-time)Date and time the IdentityProvider 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, regionDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Gets the specified identity provider's information.<br />
listselectprotocol, compartmentId, regionpage, limit, name, sortBy, sortOrder, lifecycleStateDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., SAML2 for<br />identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the<br />compartment ID (remember that the tenancy is simply the root compartment).<br />See [Where to Get the Tenancy's OCID and User's OCID](/Content/API/Concepts/apisigningkey.htm#five).<br />
createinsertregion, name, compartmentId, productType, description, protocolopc-retry-tokenDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Creates a new identity provider in your tenancy. For more information, see<br />[Identity Providers and Federation](/Content/Identity/Concepts/federation.htm).<br /><br />You must specify your tenancy's OCID as the compartment ID in the request object.<br />Remember that the tenancy is simply the root compartment. For information about<br />OCIDs, see [Resource Identifiers](/Content/General/Concepts/identifiers.htm).<br /><br />You must also specify a name for the IdentityProvider, which must be unique<br />across all IdentityProvider objects in your tenancy and cannot be changed.<br /><br />You must also specify a description for the IdentityProvider (although<br />it can be an empty string). It does not have to be unique, and you can change<br />it anytime with<br />[UpdateIdentityProvider](#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider).<br /><br />After you send your request, the new object's lifecycleState will temporarily<br />be CREATING. Before using the object, first make sure its lifecycleState has<br />changed to ACTIVE.<br />
updateupdateidentityProviderId, region, protocolif-matchDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Updates the specified identity provider.<br />
deletedeleteidentityProviderId, regionif-matchDeprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Deletes the specified identity provider. The identity provider must not have<br />any group mappings (see [IdpGroupMapping](#/en/identity/20160918/IdpGroupMapping/)).<br />
reset_idp_scim_clientexecidentityProviderId, regionResets the OAuth2 client credentials for the SCIM client associated with this identity provider.<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
compartmentIdstringThe OCID of the compartment (remember that the tenancy is simply the root compartment).
identityProviderIdstringThe OCID of the identity provider.
protocolstringThe protocol used for federation.
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.
lifecycleStatestringA filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
limitintegerThe maximum number of items to return in a paginated "List" call.
namestringA filter to only return resources that match the given name exactly.
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.
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC). The NAME sort order is case sensitive.

SELECT examples​

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

SELECT
id,
name,
compartmentId,
definedTags,
description,
freeformTags,
inactiveStatus,
lifecycleState,
productType,
protocol,
timeCreated
FROM oci.identity.identity_providers
WHERE identityProviderId = '{{ identityProviderId }}' -- 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 new identity provider in your tenancy. For more information, see<br />[Identity Providers and Federation](/Content/Identity/Concepts/federation.htm).<br /><br />You must specify your tenancy's OCID as the compartment ID in the request object.<br />Remember that the tenancy is simply the root compartment. For information about<br />OCIDs, see [Resource Identifiers](/Content/General/Concepts/identifiers.htm).<br /><br />You must also specify a name for the IdentityProvider, which must be unique<br />across all IdentityProvider objects in your tenancy and cannot be changed.<br /><br />You must also specify a description for the IdentityProvider (although<br />it can be an empty string). It does not have to be unique, and you can change<br />it anytime with<br />[UpdateIdentityProvider](#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider).<br /><br />After you send your request, the new object's lifecycleState will temporarily<br />be CREATING. Before using the object, first make sure its lifecycleState has<br />changed to ACTIVE.<br />

INSERT INTO oci.identity.identity_providers (
compartmentId,
definedTags,
description,
freeformTags,
name,
productType,
protocol,
region,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ description }}' /* required */,
'{{ freeformTags }}',
'{{ name }}' /* required */,
'{{ productType }}' /* required */,
'{{ protocol }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
name,
compartmentId,
definedTags,
description,
freeformTags,
inactiveStatus,
lifecycleState,
productType,
protocol,
timeCreated
;

UPDATE examples​

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

UPDATE oci.identity.identity_providers
SET 
definedTags = '{{ definedTags }}',
description = '{{ description }}',
freeformTags = '{{ freeformTags }}',
protocol = '{{ protocol }}'
WHERE 
identityProviderId = '{{ identityProviderId }}' --required
AND region = '{{ region }}' --required
AND protocol = '{{ protocol }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
name,
compartmentId,
definedTags,
description,
freeformTags,
inactiveStatus,
lifecycleState,
productType,
protocol,
timeCreated;

DELETE examples​

Deprecated. For more information, see [Deprecated IAM Service APIs](/Content/Identity/Reference/deprecatediamapis.htm).<br /><br />Deletes the specified identity provider. The identity provider must not have<br />any group mappings (see [IdpGroupMapping](#/en/identity/20160918/IdpGroupMapping/)).<br />

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

Lifecycle Methods​

Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.<br />

EXEC oci.identity.identity_providers.reset_idp_scim_client 
@identityProviderId='{{ identityProviderId }}' --required, 
@region='{{ region }}' --required
;