AWS SDK Version 3 for .NET
API Reference

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.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GlobalSignOutAsync.

Namespace: Amazon.CognitoIdentityProvider
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

C#
public virtual GlobalSignOutResponse GlobalSignOut(
         GlobalSignOutRequest request
)

Parameters

request
Type: Amazon.CognitoIdentityProvider.Model.GlobalSignOutRequest

Container for the necessary parameters to execute the GlobalSignOut service method.

Return Value


The response from the GlobalSignOut service method, as returned by CognitoIdentityProvider.

Exceptions

ExceptionCondition
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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

See Also