AWS SDK Version 3 for .NET
API Reference

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.

Completes registration of a passkey 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:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCompleteWebAuthnRegistration and EndCompleteWebAuthnRegistration.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<CompleteWebAuthnRegistrationResponse> CompleteWebAuthnRegistrationAsync(
         CompleteWebAuthnRegistrationRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CognitoIdentityProvider.Model.CompleteWebAuthnRegistrationRequest

Container for the necessary parameters to execute the CompleteWebAuthnRegistration service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CompleteWebAuthnRegistration service method, as returned by CognitoIdentityProvider.

Exceptions

ExceptionCondition
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.
WebAuthnChallengeNotFoundException This exception is thrown when the challenge from StartWebAuthn registration has expired.
WebAuthnClientMismatchException This exception is thrown when the access token is for a different client than the one in the original StartWebAuthnRegistration request.
WebAuthnCredentialNotSupportedException This exception is thrown when a user presents passkey credentials from an unsupported device or provider.
WebAuthnNotEnabledException This exception is thrown when the passkey feature isn't enabled for the user pool.
WebAuthnOriginNotAllowedException This exception is thrown when the passkey credential's registration origin does not align with the user pool relying party id.
WebAuthnRelyingPartyMismatchException This exception is thrown when the given passkey credential is associated with a different relying party ID than the user pool relying party ID.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also