Global Sign Out
| cognitoidentityprovider_global_sign_out | R Documentation |
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user¶
Description¶
Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation when your user signs out of your app. This results in the following behavior.
-
Amazon Cognito no longer accepts token-authorized user operations that you authorize with a signed-out user's access tokens. For more information, see Using the Amazon Cognito user pools API and user pool endpoints.
Amazon Cognito returns an
Access Token has been revokederror when your app attempts to authorize a user pools API request with a revoked access token that contains the scopeaws.cognito.signin.user.admin. -
Amazon Cognito no longer accepts a signed-out user's ID token in a GetId request to an identity pool with
ServerSideTokenCheckenabled for its user pool IdP configuration in CognitoIdentityProvider. -
Amazon Cognito no longer accepts a signed-out user's refresh tokens in refresh requests.
Other requests might be valid until your user's token expires.
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¶
Arguments¶
AccessToken[required] A valid access token that Amazon Cognito issued to the user who you want to sign out.
Value¶
An empty list.