CognitoIdentity / Client / unlink_identity

unlink_identity

CognitoIdentity.Client.unlink_identity(**kwargs)

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

See also: AWS API Documentation

Request Syntax

response = client.unlink_identity(
    IdentityId='string',
    Logins={
        'string': 'string'
    },
    LoginsToRemove=[
        'string',
    ]
)

Parameters:

• IdentityId (string) –

  [REQUIRED]

  A unique identifier in the format REGION:GUID.

• Logins (dict) –

  [REQUIRED]

  A set of optional name-value pairs that map provider names to provider tokens.

  • (string) –

    • (string) –

• LoginsToRemove (list) –

  [REQUIRED]

  Provider names to unlink from this identity.

  • (string) –

Returns:

None

Exceptions

• CognitoIdentity.Client.exceptions.InvalidParameterException

• CognitoIdentity.Client.exceptions.ResourceNotFoundException

• CognitoIdentity.Client.exceptions.NotAuthorizedException

• CognitoIdentity.Client.exceptions.ResourceConflictException

• CognitoIdentity.Client.exceptions.TooManyRequestsException

• CognitoIdentity.Client.exceptions.InternalErrorException

• CognitoIdentity.Client.exceptions.ExternalServiceException