- Print
- PDF
Create Token Set
- Print
- PDF
Available in Classic and VPC
Create a token set (access token and refresh token). To create a token, you must have a token generator set up.
- The token possesses all the permissions of the key held by the user who requested its creation.
- Token generators do not manage the tokens they generate, so they can't be destroyed individually. Therefore, it is crucial to take extra precautions to prevent token leakage.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /keys/{keyTag}/token-set |
Request headers
For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
keyTag | String | Required | Key tag
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
accessTokenHours | Integer or String | Optional | Access token validity time (hour)
|
refreshTokenHours | Integer or String | Optional | Refresh token validity time (hour)
|
Request example
The request example is as follows:
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code | String | - | Success or Failure |
data | Object | - | Response result |
data.refreshToken | String | - | The Jason Web Token (JWT) type refresh token created |
data.accessToken | String | - | The Jason Web Token (JWT) type access token created |
Response status codes
For response status codes common to all Key Management Service APIs, see Key Management Service response status codes.
Response example
The response example is as follows: