Skip to main content

DeleteOpenIDConnectProvider

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.

Permissions​

ActionDescriptionResource
DeleteOpenIDConnectProviderGrants permission to delete an OpenID Connect identity provider (IdP) resource object in IAMoidc-provider

Request Parameters​

For information about the parameters that are common to all actions, see Common Parameters.

OpenIDConnectProviderArn

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Errors​

InvalidInput

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

NoSuchEntity

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 404

InternalError

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

Examples​

Example​

This example illustrates one usage of DeleteOpenIDConnectProvider.

https://<partition>.iam.astran.io/?Action=DeleteOpenIDConnectProvider
&OpenIDConnectProviderArn=arn:aws:iam::123456789012:oidc-provider/server.example.com
&Version=2010-05-08
&AUTHPARAMS
<DeleteOpenIDConnectProviderResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
  <ResponseMetadata>
    <RequestId>b5e49e29-4f64-11e4-aefa-bfd6aEXAMPLE</RequestId>
  </ResponseMetadata>
</DeleteOpenIDConnectProviderResponse>

See Also​

For more information about using this API in one of the language-specific AWS SDKs, see the following: