com.amazonaws.mobileconnectors.cognitoauth.tokens

Class IdToken

java.lang.Object

com.amazonaws.mobileconnectors.cognitoauth.tokens.UserToken

com.amazonaws.mobileconnectors.cognitoauth.tokens.IdToken

public class IdToken
extends UserToken

Represents an id-token and provides methods to read token claims.

Constructor Summary

Constructors

Constructor and Description
IdToken(java.lang.String jwtToken) Create a new id token.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCognitoUsername() Returns the Cognito username set in the id token.
java.util.Date	getExpiration() Returns expiration of this id token.
java.util.Date	getIssuedAt() Returns "issued at" claim of this id token
java.lang.String	getJWTToken() Returns the id token formatted as JWT.
java.util.Date	getNotBefore() Returns "not before" claim of this id token

Methods inherited from class com.amazonaws.mobileconnectors.cognitoauth.tokens.UserToken

getToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdToken

public IdToken(java.lang.String jwtToken)

Create a new id token.

Parameters:

jwtToken - Required: Valid JWT as a String.

Method Detail

getJWTToken

public java.lang.String getJWTToken()

Returns the id token formatted as JWT.

Returns:

Id Token.

getExpiration

public java.util.Date getExpiration()
                             throws java.lang.Exception

Returns expiration of this id token.

Returns:

id token expiration claim as Date in UTC.

Throws:

java.lang.Exception

getNotBefore

public java.util.Date getNotBefore()
                            throws java.lang.Exception

Returns "not before" claim of this id token

Returns:

not before claim as Date in UTC.

Throws:

java.lang.Exception

getIssuedAt

public java.util.Date getIssuedAt()
                           throws java.lang.Exception

Returns "issued at" claim of this id token

Returns:

issue at claim as Date in UTC.

Throws:

java.lang.Exception

getCognitoUsername

public java.lang.String getCognitoUsername()
                                    throws java.lang.Exception

Returns the Cognito username set in the id token.

Returns:

Username set in this Id Token.

Throws:

java.lang.Exception