Confirm Device

cognitoidentityprovider_confirm_device

R Documentation

Confirms a device that a user wants to remember¶

Description¶

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.

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_confirm_device(AccessToken, DeviceKey,
  DeviceSecretVerifierConfig, DeviceName)

Arguments¶

AccessToken: [required] A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
DeviceKey: [required] The unique identifier, or device key, of the device that you want to update the status for.
DeviceSecretVerifierConfig: The configuration of the device secret verifier.
DeviceName: A friendly name for the device, for example MyMobilePhone.

Value¶

A list with the following syntax:

list(
  UserConfirmationNecessary = TRUE|FALSE
)

Request syntax¶

svc$confirm_device(
  AccessToken = "string",
  DeviceKey = "string",
  DeviceSecretVerifierConfig = list(
    PasswordVerifier = "string",
    Salt = "string"
  ),
  DeviceName = "string"
)