認証情報を照会し、認証情報のプレーンテキストを取得します。
操作説明
この API は、IDaaS から発行されたアクセストークンを使用して、身分認証と権限付与を行います。
渡すアクセストークンに、IDaaS 組み込みの PAM アプリケーション (特権アクセス管理) に対する「静的認証情報の取得」権限が付与されていることを確認してください。
対応する範囲は urn:cloud:idaas:pam|credential:obtain です。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /v2/{instanceId}/credentials/_/actions/obtain HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
EIAM インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。フォーマット: Bearer ${access_token}。 説明
IDaaS から発行されたアクセストークンを入力します。 |
Bearer xxxxxx |
| credentialIdentifier |
string |
必須 |
認証情報の識別子。 |
認証情報識別子テスト |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| instanceId |
string |
EIAM インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| credentialId |
string |
認証情報の ID。 |
cred_mkv7rgt4d7i4u7zqtzev2mxxxx |
| status |
string |
認証情報のステータス。有効な値:
|
enabled |
| credentialIdentifier |
string |
認証情報の識別子。 |
認証情報識別子テスト |
| credentialName |
string |
認証情報名。 |
認証情報名 |
| credentialSubjectType |
string |
認証情報が属する主題タイプ。有効な値:
|
認証トークンプロバイダー |
| credentialSubjectId |
string |
認証情報が属する主題の ID。 |
apt_werthgfdsasffxxxxx |
| credentialScenarioLabel |
string |
認証情報のシナリオラベル。有効な値:
|
llm |
| credentialType |
string |
認証情報のタイプ。有効な値:
|
api_key |
| credentialCreationType |
string |
認証情報の作成タイプ。有効な値:
|
user_custom |
| description |
string |
認証情報の説明。 |
認証情報の説明 |
| createTime |
integer |
作成時間 (UNIX タイムスタンプフォーマット)。単位: ミリ秒。 |
1649830225000 |
| updateTime |
integer |
更新時間 (UNIX タイムスタンプフォーマット)。単位: ミリ秒。 |
1649830227000 |
| credentialContent |
object |
認証情報の内容。 |
|
| oauthClientContent |
object |
OAuth クライアント認証情報タイプの認証情報の内容。 |
|
| clientId |
string |
OAuth プロトコルのクライアント ID。 |
dmvncmxersdxxxxxx |
| clientSecret |
string |
OAuth プロトコルのクライアントシークレット。 |
nsklnertyt5ddwizncxxxx |
| apiKeyContent |
object |
API キー認証情報タイプの認証情報の内容。 |
|
| apiKey |
string |
API キーの値。 |
sk-nsklncmwizncxxxx |
| credentialSharingScope |
string |
認証情報の共有範囲。 |
user_exclusive |
| exclusiveUserId |
string |
認証情報の排他的アカウントの ID。 |
user_xxx |
| credentialExternalId |
string |
認証情報の外部一意の識別子。 |
23528e9957304f57b98112c72788b5xxxxx |
例
成功レスポンス
JSONJSON
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"credentialId": "cred_mkv7rgt4d7i4u7zqtzev2mxxxx",
"status": "enabled",
"credentialIdentifier": "credential_identifier_test",
"credentialName": "credential_name",
"credentialSubjectType": "authentication_token_provider",
"credentialSubjectId": "apt_werthgfdsasffxxxxx",
"credentialScenarioLabel": "llm",
"credentialType": "api_key",
"credentialCreationType": "user_custom",
"description": "credential_description",
"createTime": 1649830225000,
"updateTime": 1649830227000,
"credentialContent": {
"oauthClientContent": {
"clientId": "dmvncmxersdxxxxxx",
"clientSecret": "nsklnertyt5ddwizncxxxx"
},
"apiKeyContent": {
"apiKey": "sk-nsklncmwizncxxxx\n"
}
},
"credentialSharingScope": "user_exclusive",
"exclusiveUserId": "user_xxx",
"credentialExternalId": "23528e9957304f57b98112c72788b5xxxxx"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。