JWT 認証トークンを取得します。
操作説明
本 API を使用するには、IDaaS が発行したアクセストークンによる認証および権限付与が必要です。
提供されるアクセストークンは、IDaaS 内の組み込み特権アクセス管理 (PAM) アプリケーションに対して認証トークンを取得する権限を有している必要があります。
対応するスコープは urn:cloud:idaas:pam|authentication_token:obtain です。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/{instanceId}/authenticationTokens/_/actions/obtainJwt HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンスの ID です。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報です。形式は 説明
IDaaS が発行したアクセストークンを使用してください。 |
Bearer xxxxxx |
| body |
object |
任意 |
リクエストボディです。 |
|
| consumerId |
string |
必須 |
認証トークンのコンシューマーの ID です。 |
test_jwt_subject |
| authenticationTokenId |
string |
必須 |
認証トークンの ID です。 |
atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
JWT 認証トークンの詳細です。 |
||
| instanceId |
string |
インスタンスの ID です。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| authenticationTokenId |
string |
認証トークンの ID です。 |
atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx |
| credentialProviderId |
string |
認証情報プロバイダーの ID です。 |
atp_01kr2cmj5gxxx4fvmls2e93dxxxxx |
| createTime |
integer |
認証トークンの作成時刻です。ミリ秒単位の UNIX タイムスタンプで表されます。 |
1649830225000 |
| updateTime |
integer |
認証トークンが最後に更新された時刻です。ミリ秒単位の UNIX タイムスタンプで表されます。 |
1649830225000 |
| authenticationTokenType |
string |
認証トークンの種別です。 説明
値は常に |
jwt |
| revoked |
boolean |
認証トークンが取り消されているかどうかを示します。 |
false |
| creatorType |
string |
認証トークンを作成したエンティティの種別です。有効な値は以下のとおりです。
|
application |
| creatorId |
string |
認証トークンの作成者の ID です。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx |
| consumerType |
string |
認証トークンを利用するエンティティの種別です。有効な値は以下のとおりです。
|
custom |
| consumerId |
string |
認証トークンのコンシューマーの ID です。 |
test_jwt_subject |
| expirationTime |
integer |
認証トークンの有効期限です。ミリ秒単位の UNIX タイムスタンプで表されます。 |
1772693568000 |
| jwtContent |
object |
JWT ベースの認証トークンの内容です。 |
|
| jwtValue |
string |
JWT の内容です。 |
eyJhbGciOixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| derivedShortToken |
string |
JWT から派生した短縮トークンです。 |
sk-Nx2vzxxxxxxxxxxxxxxxxx |
例
成功レスポンス
JSONJSON
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
"credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
"createTime": 1649830225000,
"updateTime": 1649830225000,
"authenticationTokenType": "jwt",
"revoked": false,
"creatorType": "application",
"creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"consumerType": "custom",
"consumerId": "test_jwt_subject",
"expirationTime": 1772693568000,
"jwtContent": {
"jwtValue": "eyJhbGciOixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"derivedShortToken": "sk-Nx2vzxxxxxxxxxxxxxxxxx"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。