Smaws_Client_CognitoIdentityProvider.GlobalSignOutInvalidates 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.
ServerSideTokenCheck enabled for its user pool IdP configuration in CognitoIdentityProvider.Other requests might be valid until your user's token expires. This operation doesn't clear the managed login session cookie. To clear the session for a user who signed in with managed login or the classic hosted UI, direct their browser session to the logout endpoint.
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.
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `ForbiddenException of Types.forbidden_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `PasswordResetRequiredException of Types.password_reset_required_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.global_sign_out_request ->
(Types.global_sign_out_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `ForbiddenException of Types.forbidden_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `PasswordResetRequiredException of
Types.password_reset_required_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.global_sign_out_request ->
(Types.global_sign_out_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `ForbiddenException of Types.forbidden_exception
| `InternalErrorException of Types.internal_error_exception
| `InvalidParameterException of Types.invalid_parameter_exception
| `NotAuthorizedException of Types.not_authorized_exception
| `OperationNotEnabledException of Types.operation_not_enabled_exception
| `PasswordResetRequiredException of
Types.password_reset_required_exception
| `ResourceNotFoundException of Types.resource_not_found_exception
| `TooManyRequestsException of Types.too_many_requests_exception
| `UserNotConfirmedException of Types.user_not_confirmed_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result