Renew Token Set

Classic/VPC環境で利用できます。

トークンセット(アクセストークンとリフレッシュトークン)を再生成します。

注意

トークンセットを再生成しても、既存のトークンセットは自動的に失効しません。
トークンは、トークンの生成をリクエストしたユーザーが持つキーの権限をすべて持ちます。
トークンジェネレータは生成したトークンを管理しないため、個別に失効させることはできません。したがって、トークンが流出しないように特別な注意が必要です。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
PUT	/keys/{keyTag}/token-set

リクエストヘッダ

Key Management Service APIで共通して使用されるヘッダの詳細は、Key Management Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`keyTag`	String	Required	キータグキー名から派生したキーの固有 ID Get Key Listを通じて確認 REST APIで暗号化または復号化をリクエストする際に使用キータグは機密情報として扱われない

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`accessTokenHours`	Integerまたは String	Optional	アクセストークンの有効時間(時間) 1~17520 (デフォルト: 72) `UL`: 無制限に設定する場合に入力
`refreshTokenHours`	Integer/String	Optional	リフレッシュトークンの有効時間(時間) 1~17520 (デフォルト: 2160) `UL`: 無制限に設定する場合に入力

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/token-set' \
--header 'x-ncp-ocapi-token: {Refresh Token}' \
--data '{
  "accessTokenHours": 72,
  "refreshTokenHours": 2160
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	成功したかどうか
`data`	Object	-	レスポンス結果
`data.refreshToken`	String	-	再生成した JWT(JSON Web Token)タイプのリフレッシュトークン
`data.accessToken`	String	-	再生成した JWT(JSON Web Token)タイプのアクセストークン

レスポンスステータスコード

Key Management Service APIで共通して使用されるレスポンスステータスコードの詳細は、Key Management Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "code": "SUCCESS",
  "data": {
    "refreshToken": "{JWT_REFRESH_TOKEN}",
    "accessToken": "{JWT_ACCESS_TOKEN}"
  }
}