Sign in

v16

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-04-0886158866.0 KB
Token Endpoint

Reissue ID Token

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.

post/api/{serviceId}/idtoken/reissue

Path parameters

serviceIdstring required

A service ID.

Request body

accessTokenstring required

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.

refreshTokenstring required

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

substring

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.

claimsstring

Additional claims that should be embedded in the payload part of the ID token. The format is a JSON object. This parameter is optional.

idtHeaderParamsstring

Additional parameters that should be embedded in the JWS header of the ID token. The format is a JSON object. This parameter is optional.

idTokenAudTypestring

The type of the "aud" claim of the ID token being issued. Valid values of this parameter are as follows.

ValueDescription
"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 {@link Service} (cf. {@link Service#getIdTokenAudType()}).

Response

ID token reissued successfully

resultCodestring

The code which represents the result of the API call.

resultMessagestring

A short message which explains the result of the API call.

action'OK' | 'INTERNAL_SERVER_ERROR' | 'CALLER_ERROR'

The next action that the implementation of the token endpoint should take.

responseContentstring

The response content that can be used as the message body of the token response that should be returned from the token endpoint.

idTokenstring

The reissued ID token