/ - Amazon Cognito Identity Provider

Confirms tracking of the device. This API call is the call that begins device tracking.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "AccessToken": "string", "DeviceKey": "string", "DeviceSecretVerifierConfig": { "PasswordVerifier": "string", "Salt": "string" }, "DeviceName": "string" }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

Confirms the device request.

AccessToken

string <password>

required

A valid access token that Amazon Cognito issued to the user whose device you want to confirm.

Match pattern:

[A-Za-z0-9-_=.]+

DeviceKey

string

required

The device key.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-f-]+

DeviceSecretVerifierConfig

object

optional

The configuration of the device secret verifier.

PasswordVerifier

string

optional

The password verifier.

Salt

string

optional

The salt

DeviceName

string

optional

The device name.

>= 1 characters<= 1024 characters

Examples

Responses

🟢200Success

application/json

Body

Confirms the device response.

UserConfirmationNecessary

boolean

optional

Indicates whether the user confirmation must confirm the device response.

🟠480ResourceNotFoundException

🟠481InvalidParameterException

🟠482NotAuthorizedException

🟠483InvalidPasswordException

🟠484InvalidLambdaResponseException

🟠485UsernameExistsException

🟠486InvalidUserPoolConfigurationException

🟠487TooManyRequestsException

🟠488PasswordResetRequiredException

🟠489UserNotFoundException

🟠490UserNotConfirmedException

🟠491InternalErrorException

🟠492ForbiddenException