CognitoIdentityProvider / Client / start_web_authn_registration

start_web_authn_registration#

CognitoIdentityProvider.Client.start_web_authn_registration(**kwargs)#

Requests credential creation options from your user pool for registration of a passkey authenticator. Returns information about the user pool, the user profile, and authentication requirements. Users must provide this information in their request to enroll your application with their passkey provider.

After users present this data and register with their passkey provider, return the response to your user pool in a CompleteWebAuthnRegistration API request.

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

Request Syntax

response = client.start_web_authn_registration(
    AccessToken='string'
)

Parameters:

AccessToken (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'CredentialCreationOptions': {...}|[...]|123|123.4|'string'|True|None
}

Response Structure

(dict) –
- CredentialCreationOptions (document) –
  
  The information that a user can provide in their request to register with their passkey provider.

Exceptions

CognitoIdentityProvider.Client.exceptions.ForbiddenException
CognitoIdentityProvider.Client.exceptions.InternalErrorException
CognitoIdentityProvider.Client.exceptions.InvalidParameterException
CognitoIdentityProvider.Client.exceptions.LimitExceededException
CognitoIdentityProvider.Client.exceptions.NotAuthorizedException
CognitoIdentityProvider.Client.exceptions.TooManyRequestsException
CognitoIdentityProvider.Client.exceptions.WebAuthnNotEnabledException
CognitoIdentityProvider.Client.exceptions.WebAuthnConfigurationMissingException