認証情報プロバイダーのリストを取得します。
今すぐお試しください
テスト
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 |
任意 |
認証情報プロバイダーのステータス。有効な値:
|
enabled |
|
| 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 |
認証情報プロバイダーの説明。 |
これは説明の例です |
| 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。 |
クライアント_id_例_xxx |
| TokenEndpoint |
string |
OAuth プロトコルのトークンエンドポイント。 |
https://example.com/トークン |
| Scope |
string |
OAuth プロトコルのスコープ。権限の範囲を指定します。 説明
認証情報プロバイダーで構成されたスコープは、デフォルト値として機能します。DeveloperAPI を呼び出して OAuth アクセストークンを取得する際にスコープパラメーターが指定されていない場合、認証情報プロバイダーで構成されたスコープがトークンの発行に使用されます。 説明
複数のスコープ値はスペースで区切られます。 |
example:test_01 example:test_02 |
| AuthorizationFlow |
string |
OAuth 権限付与フロータイプ。有効な値:
|
m2m |
| AuthorizationEndpoint |
string |
OAuth プロトコルの権限付与エンドポイント。 |
https://example.com/authorize |
| ProviderVendor |
string |
OAuth プロバイダーベンダータイプ。有効な値:
|
custom |
| DiscoveryUrl |
string |
OAuth ディスカバリードキュメントの URL。 |
https://example.com/.well-known/openid-構成 |
| SystemRedirectUri |
string |
システム生成リダイレクト URI。 |
https://example.com/呼び出し |
| PkceEnabled |
boolean |
PKCE が有効かどうかを示します。 |
true |
| PkceChallengeMethod |
string |
PKCE でコードチャレンジを計算するために使用されるアルゴリズム。有効な値:
|
S256 |
| Issuer |
string |
OAuth プロトコルの発行者エンドポイント。 |
https://example.com/issuer |
| 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",
"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": "m2m\n",
"AuthorizationEndpoint": "https://example.com/authorize\n",
"ProviderVendor": "custom\n",
"DiscoveryUrl": "https://example.com/.well-known/openid-configuration\n",
"SystemRedirectUri": "https://example.com/callback\n",
"PkceEnabled": true,
"PkceChallengeMethod": "S256\n",
"Issuer": "https://example.com/issuer\n"
},
"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。"
]
}
}
}
]
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。