AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
For .NET Core this operation is only available in asynchronous form. Please refer to StartWebAuthnRegistrationAsync.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public virtual StartWebAuthnRegistrationResponse StartWebAuthnRegistration( StartWebAuthnRegistrationRequest request )
Container for the necessary parameters to execute the StartWebAuthnRegistration service method.
| Exception | Condition |
|---|---|
| ForbiddenException | This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool. |
| InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
| InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
| LimitExceededException | This exception is thrown when a user exceeds the limit for a requested Amazon Web Services resource. |
| NotAuthorizedException | This exception is thrown when a user isn't authorized. |
| TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
| WebAuthnConfigurationMissingException | This exception is thrown when a user pool doesn't have a configured relying party id or a user pool domain. |
| WebAuthnNotEnabledException | This exception is thrown when the passkey feature isn't enabled for the user pool. |
.NET Framework:
Supported in: 4.5 and newer, 3.5