---
title: "Reissue ID Token"
method: POST
path: "/api/{serviceId}/idtoken/reissue"
tags: ["Token Endpoint"]
---

# Reissue ID Token

`POST /api/{serviceId}/idtoken/reissue`

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](https://authlete.github.io/authlete-java-common/com/authlete/common/dto/TokenResponse.Action.html#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.

## Path parameters

- `serviceId` string, required

## Request body

- IdtokenReissueRequest
  - `accessToken` string, 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.
  - `refreshToken` string, required — The value of this parameter should be the value of the "`refreshToken`" parameter in a response from the `/auth/token` API.
  - `sub` string — 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.
  - `claims` string — Additional claims that should be embedded in the payload part of the ID token. The format is a JSON object. This parameter is optional.
  - `idtHeaderParams` string — Additional parameters that should be embedded in the JWS header of the ID token. The format is a JSON object. This parameter is optional.
  - `idTokenAudType` string — 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 {@link Service} (cf. {@link Service#getIdTokenAudType()}).

## Response `200`

ID token reissued successfully

- IdtokenReissueResponse
  - `resultCode` string — The code which represents the result of the API call.
  - `resultMessage` string — 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.
  - `responseContent` string — The response content that can be used as the message body of the token response that should be returned from the token endpoint.
  - `idToken` string — The reissued ID token

## Other responses

- `400`
- `401`
- `403`
- `429` — The request exceeded the request rate permitted for the endpoint.
- `500`

---

[API](https://skmtc.net/authlete/apis/authlete-api.md) · [All operations](https://skmtc.net/authlete/apis/authlete-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/authlete/authlete-api/versions/7ad74ab64749/schema)