com.amazonaws.services.cognitoidentityprovider.model

Class GlobalSignOutRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.GlobalSignOutRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GlobalSignOutRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Signs out a user from all devices. GlobalSignOut invalidates all identity, access and refresh tokens that Amazon Cognito has issued to a user. A user can still use a hosted UI cookie to retrieve new tokens for the duration of the 1-hour cookie validity period.

Your app isn't aware that a user's access token is revoked unless it attempts to authorize a user pools API request with an access token that contains the scope aws.cognito.signin.user.admin. Your app might otherwise accept access tokens until they expire.

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 native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GlobalSignOutRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessToken() A valid access token that Amazon Cognito issued to the user who you want to sign out.
int	hashCode()
void	setAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user who you want to sign out.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GlobalSignOutRequest	withAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user who you want to sign out.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GlobalSignOutRequest

public GlobalSignOutRequest()

Method Detail

getAccessToken

public java.lang.String getAccessToken()

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

A valid access token that Amazon Cognito issued to the user who you want to sign out.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user who you want to sign out.

withAccessToken

public GlobalSignOutRequest withAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user who you want to sign out.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object