Skip to content

Delete User

cognitoidentityprovider_delete_user R Documentation

Self-deletes a user profile

Description

Self-deletes a user profile. A deleted user profile can no longer be used to sign in and can't be restored.

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_delete_user(AccessToken)

Arguments

AccessToken

[required] A valid access token that Amazon Cognito issued to the user whose user profile you want to delete.

Value

An empty list.

Request syntax

svc$delete_user(
  AccessToken = "string"
)