ConfirmDevice
Confirms a device that a user wants to remember. A remembered device is a "Remember me on this device" option for user pools that perform authentication with the device key of a trusted device in the back end, instead of a user-provided MFA code. For more information about device authentication, see Working with user devices in your user pool.
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 AWS 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.
Request Syntax
{
"AccessToken": "string
",
"DeviceKey": "string
",
"DeviceName": "string
",
"DeviceSecretVerifierConfig": {
"PasswordVerifier": "string
",
"Salt": "string
"
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- AccessToken
-
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
.Type: String
Pattern:
[A-Za-z0-9-_=.]+
Required: Yes
- DeviceKey
-
The unique identifier, or device key, of the device that you want to update the status for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-f-]+
Required: Yes
- DeviceName
-
A friendly name for the device, for example
MyMobilePhone
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- DeviceSecretVerifierConfig
-
The configuration of the device secret verifier.
Type: DeviceSecretVerifierConfigType object
Required: No
Response Syntax
{
"UserConfirmationNecessary": boolean
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UserConfirmationNecessary
-
When
true
, your user must confirm that they want to remember the device. Prompt the user for an answer.You must then make an UpdateDeviceStatus request that sets the device to
remembered
ornot_remembered
.When
false
, immediately sets the device as remembered and eligible for device authentication.You can configure your user pool to always remember devices, in which case this response is
false
, or to allow users to opt in, in which case this response istrue
. Configure this option under Device tracking in the Sign-in menu of your user pool.You can also configure this option with the
DeviceConfiguration
parameter of a CreateUserPool or UpdateUserPool request.Type: Boolean
Errors
For information about the errors that are common to all actions, see Common Errors.
- DeviceKeyExistsException
-
This exception is thrown when a user attempts to confirm a device with a device key that already exists.
HTTP Status Code: 400
- ForbiddenException
-
This exception is thrown when AWS WAF doesn't allow your request based on a web ACL that's associated with your user pool.
HTTP Status Code: 400
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidLambdaResponseException
-
This exception is thrown when Amazon Cognito encounters an invalid AWS Lambda response.
HTTP Status Code: 400
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- InvalidPasswordException
-
This exception is thrown when Amazon Cognito encounters an invalid password.
HTTP Status Code: 400
- InvalidUserPoolConfigurationException
-
This exception is thrown when the user pool configuration is not valid.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- PasswordResetRequiredException
-
This exception is thrown when a password reset is required.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
- UsernameExistsException
-
This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.
HTTP Status Code: 400
- UserNotConfirmedException
-
This exception is thrown when a user isn't confirmed successfully.
HTTP Status Code: 400
- UserNotFoundException
-
This exception is thrown when a user isn't found.
HTTP Status Code: 400
Examples
Example
The following example request confirms a device for the user with the access
token "eyJra456defEXAMPLE". In the user pool in this example, the user must
confirm that they want to remember the device with a new UpdateDeviceStatus request that sets
DeviceRememberedStatus
to true
for the device with
key a1b2c3d4-5678-90ab-cdef-EXAMPLE11111
.
Sample Request
POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.ConfirmDevice
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
"AccessToken": "eyJra456defEXAMPLE",
"DeviceKey": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
"DeviceName": "MyMobileDevice",
"DeviceSecretVerifierConfig": {
"PasswordVerifier": "[calculated verifier string]",
"Salt": "[salt]"
}
}
Sample Response
HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
"UserConfirmationNecessary": true
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: