CognitoIdentityProvider / Client / delete_web_authn_credential

delete_web_authn_credential#

CognitoIdentityProvider.Client.delete_web_authn_credential(**kwargs)#

Deletes a registered passkey, or webauthN, device for the currently signed-in user.

Authorize this action with a signed-in user’s access token. It must include the scope aws.cognito.signin.user.admin.

See also: AWS API Documentation

Request Syntax

response = client.delete_web_authn_credential(
    AccessToken='string',
    CredentialId='string'
)
Parameters:
  • AccessToken (string) –

    [REQUIRED]

    A valid access token that Amazon Cognito issued to the user whose passkey you want to delete.

  • CredentialId (string) –

    [REQUIRED]

    The unique identifier of the passkey that you want to delete. Look up registered devices with ListWebAuthnCredentials.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CognitoIdentityProvider.Client.exceptions.ForbiddenException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException