AdminUserGlobalSignOutRequest Class

Container for the parameters to the AdminUserGlobalSignOut operation. Invalidates the identity, access, and refresh tokens that Amazon Cognito issued to a user. Call this operation with your administrative credentials 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.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
      Amazon.CognitoIdentityProvider.Model.AdminUserGlobalSignOutRequest

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

Syntax

public class AdminUserGlobalSignOutRequest : AmazonCognitoIdentityProviderRequest
         IAmazonWebServiceRequest

The AdminUserGlobalSignOutRequest type exposes the following members

Constructors

	Name	Description
	AdminUserGlobalSignOutRequest()

Properties

Name Type Description

	Name	Type	Description
	Username	System.String	Gets and sets the property Username. The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If `username` isn't an alias attribute in your user pool, this value must be the `sub` of a local user or the username of a user from a third-party IdP.
	UserPoolId	System.String	Gets and sets the property UserPoolId. The user pool ID.

Username

System.String

Gets and sets the property Username.

The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

UserPoolId

System.String

Gets and sets the property UserPoolId.

The user pool ID.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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