com.amazonaws.services.cognitoidentityprovider.model

Class AdminUserGlobalSignOutRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminUserGlobalSignOutRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Signs out a user from all devices. AdminUserGlobalSignOut 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 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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminUserGlobalSignOutRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getUsername() The user name.
java.lang.String	getUserPoolId() The user pool ID.
int	hashCode()
void	setUsername(java.lang.String username) The user name.
void	setUserPoolId(java.lang.String userPoolId) The user pool ID.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminUserGlobalSignOutRequest	withUsername(java.lang.String username) The user name.
AdminUserGlobalSignOutRequest	withUserPoolId(java.lang.String userPoolId) The user pool ID.

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

AdminUserGlobalSignOutRequest

public AdminUserGlobalSignOutRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

withUserPoolId

public AdminUserGlobalSignOutRequest withUserPoolId(java.lang.String userPoolId)

The user pool ID.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

Returns:

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

getUsername

public java.lang.String getUsername()

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name.

setUsername

public void setUsername(java.lang.String username)

The user name.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name.

withUsername

public AdminUserGlobalSignOutRequest withUsername(java.lang.String username)

The user name.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name.

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