Get Token Generator

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

トークンを発行できるトークンジェネレータを照会します。

リクエスト

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

メソッド	URI
GET	/keys/{keyTag}/token-generator

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/token-generator' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`code`	String	-	成功したかどうか
`data`	Object	-	レスポンス結果
`data.tokenGeneratorId`	String	-	トークンジェネレータ ID
`data.status`	String	-	トークンジェネレータの状態 `ACTIVE` \| `INACTIVE` `ACTIVE`: 有効化 `INACTIVE`: 無効化
`data.enabledDate`	Long	-	トークンジェネレータが有効化した日時(ミリ秒) Unix Timestamp形式
`data.disabledDate`	Long	-	トークンジェネレータが無効化した日時(ミリ秒) Unix Timestamp形式
`data.issuedTokenCount`	Integer	-	発行トークン数

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

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

レスポンス例

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

トークンジェネレータの有効化時

{
    "code": "SUCCESS",
    "data": {
        "tokenGeneratorId": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z7",
        "status": "ACTIVE",
        "enabledDate": 1733708179000,
        "issuedTokenCount": 1
    }
}

トークンジェネレータの無効化時

{
    "code": "SUCCESS",
    "data": {
        "status": "INACTIVE",
        "disabledDate": 1733447855000
    }
}