Method: Aws::CognitoIdentityProvider::Client#delete_web_authn_credential

Defined in:

lib/aws-sdk-cognitoidentityprovider/client.rb

#delete_web_authn_credential(params = {}) ⇒ Struct

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 markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html

Examples:

Request syntax with placeholder values

resp = client.delete_web_authn_credential({
  access_token: "TokenModelType", # required
  credential_id: "StringType", # required
})

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :access_token (required, String) —

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

• :credential_id (required, String) —

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

  [1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListWebAuthnCredentials.html

Returns:

• (Struct) —

  Returns an empty response.

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-cognitoidentityprovider/client.rb', line 6649

def delete_web_authn_credential(params = {}, options = {})
  req = build_request(:delete_web_authn_credential, params)
  req.send_request(options)
end