Start Web Authn Registration

cognitoidentityprovider_start_web_authn_registration

R Documentation

Requests credential creation options from your user pool for registration of a passkey authenticator¶

Description¶

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.

Usage¶

cognitoidentityprovider_start_web_authn_registration(AccessToken)

Arguments¶

AccessToken: [required] A valid access token that Amazon Cognito issued to the user whose passkey metadata you want to generate.

Value¶

A list with the following syntax:

list(
  CredentialCreationOptions = list()
)

Request syntax¶

svc$start_web_authn_registration(
  AccessToken = "string"
)