AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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 revoked
error when your app
attempts to authorize a user pools API request with a revoked access token that contains
the scope aws.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 ServerSideTokenCheck
enabled 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.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGlobalSignOut and EndGlobalSignOut.
Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
public abstract Task<GlobalSignOutResponse> GlobalSignOutAsync( GlobalSignOutRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GlobalSignOut service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Exception | Condition |
---|---|
ForbiddenException | This exception is thrown when WAF doesn't allow your request based on a web ACL that's associated with your user pool. |
InternalErrorException | This exception is thrown when Amazon Cognito encounters an internal error. |
InvalidParameterException | This exception is thrown when the Amazon Cognito service encounters an invalid parameter. |
NotAuthorizedException | This exception is thrown when a user isn't authorized. |
PasswordResetRequiredException | This exception is thrown when a password reset is required. |
ResourceNotFoundException | This exception is thrown when the Amazon Cognito service can't find the requested resource. |
TooManyRequestsException | This exception is thrown when the user has made too many requests for a given operation. |
UserNotConfirmedException | This exception is thrown when a user isn't confirmed successfully. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5