CognitoIdentityProvider / Client / delete_web_authn_credential

delete_web_authn_credential#

CognitoIdentityProvider.Client.delete_web_authn_credential(**kwargs)#

Deletes a registered passkey, or webauthN, authenticator 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.

Note

Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

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 credential 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