Package com.authlete.common.dto

Class IDTokenReissueRequest

java.lang.Object

com.authlete.common.dto.IDTokenReissueRequest

All Implemented Interfaces:

Serializable

public class IDTokenReissueRequest
extends Object
implements Serializable

A request to Authlete's /idtoken/reissue API.

The API is expected to be called only when the value of the "action" parameter in a response from the /auth/token API is ID_TOKEN_REISSUABLE. The purpose of the /idtoken/reissue API is to generate a token response that includes a new ID token together with a new access token and a refresh token.

Regarding the preparation for the API call, see the description of the TokenResponse class.

Since:

3.68, Authlete 2.3.8, Authlete 3.0

See Also:

OpenID Connect Core 1.0, 12.2. Successful Refresh Response, TokenResponse, IDTokenReissueResponse, Serialized Form

Constructor Summary

Constructors

Constructor	Description
IDTokenReissueRequest()

Method Summary

Modifier and Type	Method	Description
String	getAccessToken()	Get the access token.
String	getClaims()	Get additional claims that should be embedded in the payload part of the ID token.
String	getIdtHeaderParams()	Get additional parameters that should be embedded in the JWS header of the ID token.
String	getIdTokenAudType()	Get the type of the "aud" claim of the ID token being issued.
String	getRefreshToken()	Get the refresh token.
String	getSub()	Get the value that should be used as the value of the "sub" claim of the ID token.
IDTokenReissueRequest	setAccessToken(String accessToken)	Set the access token.
IDTokenReissueRequest	setClaims(String claims)	Set additional claims that should be embedded in the payload part of the ID token.
IDTokenReissueRequest	setIdtHeaderParams(String params)	Set additional parameters that should be embedded in the JWS header of the ID token.
IDTokenReissueRequest	setIdTokenAudType(String type)	Set the type of the "aud" claim of the ID token being issued.
IDTokenReissueRequest	setRefreshToken(String refreshToken)	Set the refresh token.
IDTokenReissueRequest	setSub(String sub)	Set the value that should be used as the value of the "sub" claim of the ID token.

Methods inherited from class java.lang.Object

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

Constructor Detail

IDTokenReissueRequest

public IDTokenReissueRequest()

Method Detail

getAccessToken

public String getAccessToken()

Get the access token.

The value of this parameter should be (a) the value of the "jwtAccessToken" parameter in a response from the /auth/token API when the value is available, or (b) the value of the "accessToken" parameter in the response from the /auth/token API when the value of the "jwtAccessToken" parameter is not available.

Returns:

The access token that has been newly issued as the result of the /auth/token API call.

setAccessToken

public IDTokenReissueRequest setAccessToken(String accessToken)

Set the access token.

The value of this parameter should be (a) the value of the "jwtAccessToken" parameter in a response from the /auth/token API when the value is available, or (b) the value of the "accessToken" parameter in the response from the /auth/token API when the value of the "jwtAccessToken" parameter is not available.

Parameters:

accessToken - The access token that has been newly issued as the result of the /auth/token API call.

Returns:

this object.

getRefreshToken

public String getRefreshToken()

Get the refresh token.

The value of this parameter should be the value of the "refreshToken" parameter in a response from the /auth/token API.

Returns:

The refresh token that has been prepared as the result of the /auth/token API call. It may be a new refresh token or the same refresh token included in the token request, depending on the service configuration.

setRefreshToken

public IDTokenReissueRequest setRefreshToken(String refreshToken)

Set the refresh token.

The value of this parameter should be the value of the "refreshToken" parameter in a response from the /auth/token API.

Parameters:

refreshToken - The refresh token that has been prepared as the result of the /auth/token API call. It may be a new refresh token or the same refresh token included in the token request, depending on the service configuration.

Returns:

this object.

getSub

public String getSub()

Get the value that should be used as the value of the "sub" claim of the ID token.

This parameter is optional. When omitted, the value of the subject associated with the access token is used.

Returns:

The value that should be used as the value of the "sub" claim of the ID token.

setSub

public IDTokenReissueRequest setSub(String sub)

Set the value that should be used as the value of the "sub" claim of the ID token.

This parameter is optional. When omitted, the value of the subject associated with the access token is used.

Parameters:

sub - The value that should be used as the value of the "sub" claim of the ID token.

Returns:

this object.

getClaims

public String getClaims()

Get additional claims that should be embedded in the payload part of the ID token. The format is a JSON object.

This parameter is optional.

Returns:

Additional claims that should be embedded in the payload part of the ID token.

setClaims

public IDTokenReissueRequest setClaims(String claims)

Set additional claims that should be embedded in the payload part of the ID token. The format must be a JSON object.

This parameter is optional.

Parameters:

claims - Additional claims that should be embedded in the payload part of the ID token.

Returns:

this object.

getIdtHeaderParams

public String getIdtHeaderParams()

Get additional parameters that should be embedded in the JWS header of the ID token. The format is a JSON object.

This parameter is optional.

Returns:

Additional parameters that should be embedded in the JWS header of the ID token.

setIdtHeaderParams

public IDTokenReissueRequest setIdtHeaderParams(String params)

Set additional parameters that should be embedded in the JWS header of the ID token. The format must be a JSON object.

This parameter is optional.

Parameters:

params - Additional parameters that should be embedded in the JWS header of the ID token.

Returns:

this object.

getIdTokenAudType

public String getIdTokenAudType()

Get the type of the "aud" claim of the ID token being issued.

Valid values of this parameter are as follows.

Value	Description
"array"	The type of the aud claim becomes an array of strings.
"string"	The type of the aud claim becomes a single string.

This parameter is optional, and the default value on omission is "array".

This parameter takes precedence over the idTokenAudType property of Service (cf. Service.getIdTokenAudType()).

Returns:

The type of the aud claim of the ID token.

setIdTokenAudType

public IDTokenReissueRequest setIdTokenAudType(String type)

Set the type of the "aud" claim of the ID token being issued.

Valid values of this parameter are as follows.

Value	Description
"array"	The type of the aud claim becomes an array of strings.
"string"	The type of the aud claim becomes a single string.

This parameter is optional, and the default value on omission is "array".

This parameter takes precedence over the idTokenAudType property of Service (cf. Service.getIdTokenAudType()).

Parameters:

type - The type of the aud claim of the ID token.

Returns:

this object.