認証情報プロバイダーを一覧表示します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
eiam:ListCredentialProviders |
list |
*CredentialProvider。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx。 |
| NextToken |
string |
任意 |
ページネーショントークン。 |
NTxxxxxexample。 |
| MaxResults |
integer |
任意 |
ページングクエリの 1 ページあたりのエントリの最大値。 |
20 |
| CredentialProviderIds |
array |
任意 |
認証情報プロバイダー ID のリスト。 |
|
|
string |
任意 |
認証情報プロバイダーの ID。 |
atp_01kr2cmj5gxxx4fvmls2e93dxxxxx。 |
|
| CredentialProviderTypes |
array |
任意 |
認証情報プロバイダータイプのリスト。 |
|
|
string |
任意 |
認証情報プロバイダーのタイプ。有効な値: |
oauth。 |
|
| Statuses |
array |
任意 |
認証情報プロバイダーステータスのリスト。 |
|
|
string |
任意 |
認証情報プロバイダーのステータス。有効な値: |
有効 |
|
| Filter |
array<object> |
任意 |
フィルター条件のリスト。 |
|
|
object |
任意 |
フィルター条件。 |
||
| Name |
string |
任意 |
フィルター条件の名前。有効な値: |
CredentialProviderName。 |
| Value |
array |
任意 |
フィルター条件値のリスト。 |
|
|
string |
任意 |
フィルター条件の条件値。 |
test_example_name。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| TotalCount |
integer |
リスト内のエントリの総数。 |
100 |
| NextToken |
string |
この呼び出しで返されるページネーショントークン。 |
NTxxxexample。 |
| MaxResults |
integer |
ページングクエリの 1 ページあたりのエントリの最大値。 |
20 |
| CredentialProviders |
array<object> |
認証情報プロバイダーのリスト。 |
|
|
array<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 プロトコルにおける client_id。 |
client_id_example_xxx |
| TokenEndpoint |
string |
OAuth プロトコルのトークンエンドポイント。 |
https://example.com/token |
| Scope |
string |
OAuth プロトコルにおける範囲。権限の範囲を定義します。 |
example:test_01 example:test_02 |
| AuthorizationFlow |
string |
OAuth 権限付与フローのタイプ。有効な値: |
|
| AuthorizationEndpoint |
string |
ユーザーに権限付与を案内するために呼び出されるエンドポイントアドレス。条件付き必須: AuthorizationFlow が user_federation に設定され、かつ ProviderVendor が custom に設定されている場合、このパラメーターは必須です。プリセットベンダーの場合、この値は DiscoveryUrl を通じて自動的に設定できます。 |
|
| ProviderVendor |
string |
プリセットベンダーまたはカスタム構成。任意。デフォルト値: custom。 |
|
| DiscoveryUrl |
string |
OAuth エンドポイント構成のセットを自動的に取得するために呼び出されるディスカバリードキュメントの URL。条件付き任意: AuthorizationFlow が user_federation に設定されている場合に使用します。DiscoveryUrl が指定されていない場合は、TokenEndpoint や AuthorizationEndpoint などのフィールドを手動で構成する必要があります。 |
|
| SystemRedirectUri |
string |
認証情報プロバイダーの作成時にシステムによって自動的に生成されるリダイレクト URI。この値を 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 エンドポイントのアドレス。 |
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",
"TotalCount": 100,
"NextToken": "NTxxxexample。",
"MaxResults": 20,
"CredentialProviders": [
{
"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": true,
"AllowedTokenIssuers": [
"https://test.issuer.com。"
]
}
}
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。