complete_web_authn_registration
async
¶
complete_web_authn_registration(
access_token: TokenModelType,
credential: Document,
*,
config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> CompleteWebAuthnRegistrationResponse
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.
Parameters:
-
access_token(TokenModelType) –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. -
credential(Document) –A RegistrationResponseJSON public-key credential response from the user's passkey provider.
Raises:
-
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.
-
OperationNotEnabledException–This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
-
PasswordResetRequiredException–This exception is thrown when a password reset is required.
-
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
StartWebAuthnregistration has expired. -
WebAuthnClientMismatchException–This exception is thrown when the access token is for a different client than the one in the original
StartWebAuthnRegistrationrequest. -
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.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_cognito_identity_provider/_services/async_cognito_identity_provider.py
3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 | |