ObtainCredential - - Alibaba Cloud ドキュメントセンター

シークレットのプレーンテキストを取得します。

操作説明

この API は、認証と認可に IDaaS のアクセストークンを使用します。

アクセストークンには、IDaaS の組み込み特権アクセス管理 (PAM) アプリケーションの静的認証情報を取得するための権限が必要です。

説明

必要なスコープは urn:cloud:idaas:pam|credential:obtain です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエスト構文

GET /v2/{instanceId}/credentials/_/actions/obtain HTTP/1.1

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
instanceId	string	必須	IDaaS インスタンスの ID です。	idaas_ue2jvisn35ea5lmthk267xxxxx

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Authorization	string	必須	リクエストの認可情報。フォーマットは `Bearer ${access_token}` です。説明 IDaaS が発行したアクセストークンを使用します。	Bearer xxxxxx
credentialIdentifier	string	必須	取得する認証情報の識別子です。	credential_identifier_test

レスポンスフィールド

フィールド	型	説明	例
	object
instanceId	string	EIAM インスタンス ID です。	idaas_ue2jvisn35ea5lmthk267xxxxx
credentialId	string	認証情報 ID です。	cred_mkv7rgt4d7i4u7zqtzev2mxxxx
status	string	認証情報のステータスです。有効な値： `enabled`：認証情報が有効です。 `disabled`：認証情報が無効です。	enabled
credentialIdentifier	string	認証情報識別子です。	credential_identifier_test
credentialName	string	認証情報の名前です。	credential_name
credentialSubjectType	string	認証情報のサブジェクトタイプです。有効な値： `authentication_token_provider`：認証トークンプロバイダー。	authentication_token_provider
credentialSubjectId	string	認証情報のサブジェクトの ID です。	apt_werthgfdsasffxxxxx
credentialScenarioLabel	string	認証情報の使用シナリオです。有効な値： `llm`：大規模言語モデルで使用します。 `saas`：サードパーティ SaaS アプリケーションで使用します。	llm
credentialType	string	認証情報のタイプです。有効な値： `api_key`：API キー。 `oauth_client`：OAuth クライアント。	api_key
credentialCreationType	string	認証情報の作成方法を示します。有効な値： `system_init`：システムによる初期化。 `user_custom`：ユーザーによる作成。	user_custom
description	string	認証情報の説明です。	credential_description
createTime	integer	認証情報の作成日時。ミリ秒単位の UNIX タイムスタンプです。	1649830225000
updateTime	integer	認証情報の最終更新日時。ミリ秒単位の UNIX タイムスタンプです。	1649830227000
credentialContent	object	認証情報の詳細な内容です。このオブジェクトの構造は、`credentialType` の値によって異なります。
oauthClientContent	object	OAuth クライアント認証情報の詳細が含まれます。`credentialType` が `oauth_client` の場合にのみ返されます。
clientId	string	OAuth 2.0 のクライアント ID です。	dmvncmxersdxxxxxx
clientSecret	string	OAuth 2.0 のクライアントシークレットです。	nsklnertyt5ddwizncxxxx
apiKeyContent	object	API キー認証情報の詳細が含まれます。`credentialType` が `api_key` の場合にのみ返されます。
apiKey	string	API キーの値です。	sk-nsklncmwizncxxxx
credentialSharingScope	string	認証情報の共有範囲です (特定のアカウント専用であるかどうかなど)。	user_exclusive
exclusiveUserId	string	認証情報を排他的に所有するアカウントの ID です。このフィールドは、`credentialSharingScope` が `user_exclusive` の場合にのみ存在します。	user_xxx
credentialExternalId	string

例

成功レスポンス

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": ""
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。