認証情報プロバイダーを作成します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
eiam:CreateCredentialProvider |
create |
*CredentialProvider。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| InstanceId |
string |
必須 |
インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx。 |
| ClientToken |
string |
必須 |
リクエストのべき等性を保証するためのべき等性トークン。 クライアント側でパラメーター値を生成し、異なるリクエスト間で一意性を確保してください。ClientToken は ASCII 文字のみをサポートし、長さは 64 文字を超えることはできません。詳細については、リファレンス「べき等性を確保する方法」をご参照ください。 |
client-token-example |
| CredentialProviderIdentifier |
string |
必須 |
認証情報プロバイダーの識別子。 説明
使用できる文字は、大文字・小文字のアルファベット、数字、および特殊文字 |
test_example_identifier。 |
| CredentialProviderName |
string |
必須 |
認証情報プロバイダーの名前。 説明
長さは 64 文字を超えることはできません。 |
test_example_name。 |
| Description |
string |
任意 |
説明。 説明
長さは 128 文字を超えることはできません。 |
This is an example description。 |
| CredentialProviderType |
string |
必須 |
認証情報プロバイダーのタイプ。有効な値:
|
oauth。 |
| CredentialProviderConfig |
object |
任意 |
認証情報プロバイダーの構成。 |
|
| OAuthProviderConfig |
object |
任意 |
OAuth 認証情報プロバイダーの構成。 |
|
| ClientId |
string |
必須 |
OAuth プロトコルにおける client_id。 説明
長さは 128 文字を超えることはできません。 |
client_id_example_xxx |
| ClientSecret |
string |
必須 |
OAuth プロトコルにおける client_secret。 説明
長さは 1024 文字を超えることはできません。 |
client_secret_example_xxx |
| TokenEndpoint |
string |
必須 |
OAuth プロトコルのトークンエンドポイント。 説明
|
https://example.com/token |
| Scope |
string |
任意 |
OAuth プロトコルにおける範囲。権限の有効値を定義します。 説明
認証情報プロバイダー上の Scope 構成は、フォールバック値として機能します。DeveloperAPI を呼び出して OAuth アクセストークンを取得する際に scope パラメーターが指定されていない場合、認証情報プロバイダー上の Scope 構成が発行に使用されます。 重要 複数の Scope 値はスペースで区切ります。 各 Scope 値の制限事項:
|
example:test_01 example:test_02 |
| AuthorizationFlow |
string |
任意 |
OAuth 権限付与フロータイプ。有効な値: m2m: マシンツーマシン (2LO、クライアント認証情報)。user_federation: ユーザーフェデレーション (3LO、認証コード)。 |
|
| AuthorizationEndpoint |
string |
任意 |
ユーザーを権限付与プロセスに誘導するために使用されるエンドポイントアドレス。条件付き必須: AuthorizationFlow=user_federation かつ ProviderVendor=custom の場合に必須です。プリセットベンダーの場合、DiscoveryUrl を通じて自動的に設定できます。 |
|
| ProviderVendor |
string |
任意 |
プリセットベンダーまたはカスタム構成。任意。デフォルト値: custom。 |
|
| DiscoveryUrl |
string |
任意 |
OAuth エンドポイント構成を自動的に取得するために使用されるディスカバリードキュメントの URL。条件付き任意: AuthorizationFlow=user_federation の場合に使用します。DiscoveryUrl が指定されていない場合は、TokenEndpoint や AuthorizationEndpoint などのフィールドを手動で構成する必要があります。 |
|
| PkceEnabled |
boolean |
任意 |
セキュリティを強化するために PKCE 拡張を使用するかどうかを指定します。この特徴は常に有効にすることを推奨します。 |
|
| PkceChallengeMethod |
string |
任意 |
PKCE code_challenge の生成メソッド。デフォルト値: s256。 |
|
| Issuer |
string |
任意 |
||
| JwtProviderConfig |
object |
任意 |
JWT 認証情報プロバイダーの構成。 |
|
| Expiration |
integer |
任意 |
JWT の有効持続時間。単位: 秒。 |
900 |
| ExpirationCleanupEnabled |
boolean |
任意 |
JWT の有効期限クリーンアップを有効にするかどうかを指定します。 |
true。 |
| DerivedShortTokenEnabled |
boolean |
任意 |
JWT 派生ショートトークン機能を有効にするかどうかを指定します。 |
false。 |
| AllowedTokenIssuers |
array |
任意 |
許可された JWT Issuer のリスト。 説明
リストの長さは 200 を超えることはできません。 |
|
|
string |
任意 |
許可された JWT Issuer。 説明
長さは 1024 文字を超えることはできません。 |
https://test.issuer.com。 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストの ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| CredentialProviderId |
string |
認証情報プロバイダーの ID。 |
atp_01kr2cmj5gxxx4fvmls2e93dxxxxx。 |
例
成功レスポンス
JSONJSON
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"CredentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。