com.amazonaws.services.cognitoidentityprovider.model

Class RevokeTokenRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.RevokeTokenRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Revokes all of the access tokens generated by, and at the same time as, the specified refresh token. After a token is revoked, you can't use the revoked token to access Amazon Cognito user APIs, or to authorize access to your resource server.

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
RevokeTokenRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getClientId() The client ID for the token that you want to revoke.
java.lang.String	getClientSecret() The secret for the client ID.
java.lang.String	getToken() The refresh token that you want to revoke.
int	hashCode()
void	setClientId(java.lang.String clientId) The client ID for the token that you want to revoke.
void	setClientSecret(java.lang.String clientSecret) The secret for the client ID.
void	setToken(java.lang.String token) The refresh token that you want to revoke.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
RevokeTokenRequest	withClientId(java.lang.String clientId) The client ID for the token that you want to revoke.
RevokeTokenRequest	withClientSecret(java.lang.String clientSecret) The secret for the client ID.
RevokeTokenRequest	withToken(java.lang.String token) The refresh token that you want to revoke.

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

RevokeTokenRequest

public RevokeTokenRequest()

Method Detail

getToken

public java.lang.String getToken()

The refresh token that you want to revoke.

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

Returns:

The refresh token that you want to revoke.

setToken

public void setToken(java.lang.String token)

The refresh token that you want to revoke.

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

Parameters:

token -

The refresh token that you want to revoke.

withToken

public RevokeTokenRequest withToken(java.lang.String token)

The refresh token that you want to revoke.

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

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

Parameters:

token -

The refresh token that you want to revoke.

Returns:

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

getClientId

public java.lang.String getClientId()

The client ID for the token that you want to revoke.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Returns:

The client ID for the token that you want to revoke.

setClientId

public void setClientId(java.lang.String clientId)

The client ID for the token that you want to revoke.

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The client ID for the token that you want to revoke.

withClientId

public RevokeTokenRequest withClientId(java.lang.String clientId)

The client ID for the token that you want to revoke.

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

Constraints:
Length: 1 - 128
Pattern: [\w+]+

Parameters:

clientId -

The client ID for the token that you want to revoke.

Returns:

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

getClientSecret

public java.lang.String getClientSecret()

The secret for the client ID. This is required only if the client ID has a secret.

Constraints:
Length: 1 - 64
Pattern: [\w+]+

Returns:

The secret for the client ID. This is required only if the client ID has a secret.

setClientSecret

public void setClientSecret(java.lang.String clientSecret)

The secret for the client ID. This is required only if the client ID has a secret.

Constraints:
Length: 1 - 64
Pattern: [\w+]+

Parameters:

clientSecret -

The secret for the client ID. This is required only if the client ID has a secret.

withClientSecret

public RevokeTokenRequest withClientSecret(java.lang.String clientSecret)

The secret for the client ID. This is required only if the client ID has a secret.

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

Constraints:
Length: 1 - 64
Pattern: [\w+]+

Parameters:

clientSecret -

The secret for the client ID. This is required only if the client ID has a secret.

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