Forget Device
| cognitoidentityprovider_forget_device | R Documentation |
Given a device key, deletes a remembered device as the currently signed-in user¶
Description¶
Given a device key, deletes a remembered device as the currently signed-in user. 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_forget_device(AccessToken, DeviceKey)
Arguments¶
AccessToken |
A valid access token that Amazon Cognito issued to the currently
signed-in user. Must include a scope claim for
|
DeviceKey |
[required] The unique identifier, or device key, of the device that the user wants to forget. |
Value¶
An empty list.
Request syntax¶
svc$forget_device(
AccessToken = "string",
DeviceKey = "string"
)