GetCredentialProvider - Identity as a Service - Alibaba Cloud ドキュメントセンター

認証情報プロバイダーの詳細を照会します。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

eiam:GetCredentialProvider

get

*CredentialProvider。

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/credentialprovider/{#CredentialProviderId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。	idaas_ue2jvisn35ea5lmthk267xxxxx。
CredentialProviderId	string	必須	認証情報プロバイダーの ID。	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx。

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
CredentialProvider	object	認証情報プロバイダー。
InstanceId	string	インスタンスの ID。	idaas_ue2jvisn35ea5lmthk267xxxxx。
CredentialProviderId	string	認証情報プロバイダーの ID。	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx。
CredentialProviderIdentifier	string	認証情報プロバイダーのビジネス識別子。	test_example_identifier。
CredentialProviderName	string	認証情報プロバイダーの名前。	test_example_name。
CreateTime	integer	認証情報プロバイダーが作成された時間。値はミリ秒単位の UNIX タイムスタンプです。	1649830225000
UpdateTime	integer	認証情報プロバイダーが最後に更新された時間。値はミリ秒単位の UNIX タイムスタンプです。	1649830225000
Description	string	説明。	This is an example description。
CredentialProviderType	string	認証情報プロバイダーのタイプ。有効な値:	oauth。
CredentialProviderCreationType	string	認証情報プロバイダーの作成タイプ。有効な値:	user_custom。
Status	string	認証情報プロバイダーのステータス。有効な値:	enabled
CredentialProviderConfig	object	認証情報プロバイダーの構成。
ProviderCredentialIds	array	認証情報プロバイダーの機密構成に対応する認証情報 ID のリスト。説明システムは、認証情報プロバイダーの機密構成情報を認証情報の形式で安全に保存します。
	string	機密構成に対応する認証情報 ID。	cred_mkv7xxxxd7i4u7zqtzev2mxxxx
OAuthProviderConfig	object	OAuth 認証情報プロバイダーの構成。
ClientId	string	OAuth プロトコルのクライアント ID。	client_id_example_xxx
TokenEndpoint	string	OAuth プロトコルのトークンエンドポイント。	https://example.com/token
Scope	string	OAuth プロトコルの範囲。説明 OAuth 認証情報プロバイダーの範囲構成はデフォルト値として機能します。DeveloperAPI を呼び出して OAuth アクセストークンを取得する際に scope パラメーターが指定されていない場合、認証情報プロバイダーの範囲構成が発行に使用されます。重要複数の範囲値はスペースで区切ります。	example:test_01 example:test_02
AuthorizationFlow	string	OAuth 的具体授权类型。m2m: 机器对机器(2LO, Client Credentials)；user_federation: 用户联邦(3LO, Authorization Code)
AuthorizationEndpoint	string	用于引导用户进行授权的端点地址。条件必填：当 AuthorizationFlow=user_federation 且 ProviderVendor=custom 时必填；预置厂商可通过 DiscoveryUrl 自动填充
ProviderVendor	string	预置厂商或自定义配置。非必填，默认值：custom
DiscoveryUrl	string	用于自动获取 OAuth 端点配置的 Discovery 文档地址。条件可选：当 AuthorizationFlow=user_federation 时使用，如不提供 DiscoveryUrl，则需手动配置 TokenEndpoint、AuthorizationEndpoint 等字段
SystemRedirectUri	string	创建凭据提供商时系统自动生成的重定向地址，需在 OAuth 提供商处配置为 redirect_uri
PkceEnabled	boolean	是否使用 PKCE 扩展增强安全性，推荐始终启用
PkceChallengeMethod	string	PKCE code_challenge 生成方法。默认 s256
Issuer	string
JwtProviderConfig	object	JWT 認証情報プロバイダーの構成。
Issuer	string	JWT の発行者。	https://test.issuer.com
JwksEndpoint	string	JWKS エンドポイントの URL。	https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks
Expiration	integer	JWT の有効期間（秒単位）。	900
ExpirationCleanupEnabled	boolean	JWT の有効期限切れクリーンアップが有効かどうかを示します。	true
DerivedShortTokenEnabled	boolean	JWT 派生ショートトークン機能が有効かどうかを示します。	false
AllowedTokenIssuers	array	許可された JWT 発行者のリスト。
	string	許可された JWT 発行者。	https://test.issuer.com

例

成功レスポンス

JSONJSON

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "CredentialProvider": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "CredentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
    "CredentialProviderIdentifier": "test_example_identifier",
    "CredentialProviderName": "test_example_name",
    "CreateTime": 1649830225000,
    "UpdateTime": 1649830225000,
    "Description": "This is an example description",
    "CredentialProviderType": "oauth",
    "CredentialProviderCreationType": "user_custom",
    "Status": "enabled",
    "CredentialProviderConfig": {
      "ProviderCredentialIds": [
        "cred_mkv7xxxxd7i4u7zqtzev2mxxxx"
      ],
      "OAuthProviderConfig": {
        "ClientId": "client_id_example_xxx",
        "TokenEndpoint": "https://example.com/token",
        "Scope": "example:test_01 example:test_02",
        "AuthorizationFlow": "",
        "AuthorizationEndpoint": "",
        "ProviderVendor": "",
        "DiscoveryUrl": "",
        "SystemRedirectUri": "",
        "PkceEnabled": false,
        "PkceChallengeMethod": "",
        "Issuer": ""
      },
      "JwtProviderConfig": {
        "Issuer": "https://test.issuer.com",
        "JwksEndpoint": "https://example123456.aliyunidaas.com/api/v2/auths_ngz2wj35ixxxdyat55nexxxxxx/oauth2/jwks",
        "Expiration": 900,
        "ExpirationCleanupEnabled": true,
        "DerivedShortTokenEnabled": false,
        "AllowedTokenIssuers": [
          "https://test.issuer.com"
        ]
      }
    }
  }
}

エラーコード

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

変更履歴

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