有効な OAuth 認証トークンをフェッチします。
操作説明
この API は、IDaaS によって発行されたアクセストークンを使用して、身分認証と権限付与を実行します。
アクセストークンに、IDaaS の組み込み特権アクセス管理 (PAM) アプリケーションから認証トークンを取得する権限があることを確認してください。
対応するスコープは urn:cloud:idaas:pam|authentication_token:obtain です。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/{instanceId}/authenticationTokens/_/actions/fetchOAuthAccessToken HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンス ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。フォーマットは `Bearer ${access_token}` です。 説明
IDaaS によって発行されたアクセストークンを入力します。 |
Bearer xxxxxx |
| body |
object |
任意 |
リクエストボディ。 |
|
| credentialProviderIdentifier |
string |
必須 |
認証情報プロバイダーの識別子。 |
test_example_identifier |
| scope |
string |
任意 |
OAuth プロトコルのスコープ。 説明
このパラメーターを指定しない場合、発行される OAuth アクセストークンのスコープは、認証情報プロバイダーのスコープ構成によって決定されます。 重要 複数のスコープ値はスペースで区切ります。 |
example:test_01 example:test_02 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
OAuth 認証トークンの詳細。 |
||
| 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 |
認証トークンのタイプ。 説明
値は `oauth_access_token` に固定されており、OAuth アクセストークンであることを示します。 |
oauth_access_token |
| revoked |
boolean |
認証トークンが取り消されたかどうかを示します。 |
false |
| creatorType |
string |
認証トークンの作成者のタイプ。有効な値：
|
application |
| creatorId |
string |
認証トークンの作成者の ID。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx |
| consumerType |
string |
認証トークンのコンシューマーのタイプ。有効な値：
|
application |
| consumerId |
string |
認証トークンのコンシューマーの ID。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx |
| expirationTime |
integer |
認証トークンの有効期限が切れる時間。これはミリ秒単位の UNIX タイムスタンプです。 |
1772693568000 |
| oauthAccessTokenContent |
object |
OAuth アクセストークンの内容。 |
|
| accessTokenValue |
string |
OAuth プロトコルのトークンエンドポイントからの応答に含まれる `access_token` フィールド。 |
DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| tokenType |
string |
OAuth プロトコルのトークンエンドポイントからの応答に含まれる `token_type` フィールド。 |
Bearer |
| scope |
string |
OAuth プロトコルのトークンエンドポイントからの応答に含まれる `scope` フィールド。 |
example:test_01 example:test_02 |
例
成功レスポンス
JSONJSON
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
"credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
"createTime": 1649830225000,
"updateTime": 1649830225000,
"authenticationTokenType": "oauth_access_token",
"revoked": false,
"creatorType": "application",
"creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"consumerType": "application",
"consumerId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"expirationTime": 1772693568000,
"oauthAccessTokenContent": {
"accessTokenValue": "DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"tokenType": "Bearer",
"scope": "example:test_01 example:test_02"
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。