CognitoIdentityProvider / Client / delete_identity_provider

delete_identity_provider#

CognitoIdentityProvider.Client.delete_identity_provider(**kwargs)#

Deletes a user pool identity provider (IdP). After you delete an IdP, users can no longer sign in to your user pool through that IdP. For more information about user pool IdPs, see Third-party IdP sign-in.

Note

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

See also: AWS API Documentation

Request Syntax

response = client.delete_identity_provider(
    UserPoolId='string',
    ProviderName='string'
)
Parameters:

  • UserPoolId (string) –

    [REQUIRED]

    The ID of the user pool where you want to delete the identity provider.

  • ProviderName (string) –

    [REQUIRED]

    The name of the IdP that you want to delete.

Returns:

None

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.UnsupportedIdentityProviderException

  • CognitoIdentityProvider.Client.exceptions.ConcurrentModificationException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.TooManyRequestsException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException