CognitoIdentityProvider / Client / verify_user_attribute

verify_user_attribute#

CognitoIdentityProvider.Client.verify_user_attribute(**kwargs)#

Submits a verification code for a signed-in user who has added or changed a value of an auto-verified attribute. When successful, the user’s attribute becomes verified and the attribute email_verified or phone_number_verified becomes true.

If your user pool requires verification before Amazon Cognito updates the attribute value, this operation updates the affected attribute to its pending value.

Authorize this action with a signed-in user’s access token. It must include the scope aws.cognito.signin.user.admin.

Note

Amazon Cognito doesn’t evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can’t use IAM credentials to authorize requests, and you can’t grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito user pools API and user pool endpoints.

See also: AWS API Documentation

Request Syntax

response = client.verify_user_attribute(
    AccessToken='string',
    AttributeName='string',
    Code='string'
)
Parameters:

  • AccessToken (string) –

    [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.

  • AttributeName (string) –

    [REQUIRED]

    The name of the attribute that you want to verify.

  • Code (string) –

    [REQUIRED]

    The verification code that your user pool sent to the added or changed attribute, for example the user’s email address.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

    A container representing the response from the server from the request to verify user attributes.

Exceptions