Skip to content

Verify User Attribute

cognitoidentityprovider_verify_user_attribute R Documentation

Verifies the specified user attributes in the user pool

Description

Verifies the specified user attributes in the user pool.

If your user pool requires verification before Amazon Cognito updates the attribute value, VerifyUserAttribute updates the affected attribute to its pending value. For more information, see UserAttributeUpdateSettingsType.

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

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.

Usage

cognitoidentityprovider_verify_user_attribute(AccessToken,
  AttributeName, Code)

Arguments

AccessToken

[required] A valid access token that Amazon Cognito issued to the user whose user attributes you want to verify.

AttributeName

[required] The attribute name in the request to verify user attributes.

Code

[required] The verification code in the request to verify user attributes.

Value

An empty list.

Request syntax

svc$verify_user_attribute(
  AccessToken = "string",
  AttributeName = "string",
  Code = "string"
)