Skip to content

Start Web Authn Registration

cognitoidentityprovider_start_web_authn_registration R Documentation

Requests credential creation options from your user pool for the currently signed-in user

Description

Requests credential creation options from your user pool for the currently signed-in user. 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.

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 currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Value

A list with the following syntax:

list(
  CredentialCreationOptions = list()
)

Request syntax

svc$start_web_authn_registration(
  AccessToken = "string"
)