Admin Forget Device

cognitoidentityprovider_admin_forget_device

R Documentation

Forgets, or deletes, a remembered device from a user's profile

Description

Forgets, or deletes, a remembered device from a user's profile. After you forget the device, the user can no longer complete device authentication with that device and when applicable, must submit MFA codes again. For more information, see Working with devices.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_admin_forget_device(UserPoolId, Username,
  DeviceKey)

Arguments

UserPoolId

[required] The ID of the user pool where the device owner is a user.

Username

[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

DeviceKey

[required] The key ID of the device that you want to delete. You can get device keys in the response to an admin_list_devices request.

Value

An empty list.

Request syntax

svc$admin_forget_device(
  UserPoolId = "string",
  Username = "string",
  DeviceKey = "string"
)