| authProvider |
- 項目の型
- string
- 説明
-
AuthProvider コンポーネントが表現する認証プロバイダーの参照。ログインプロセスを提供し、外部システムへのアクセスを承認するサービスを定義します。
|
| certificate |
- 型
- string
- 説明
-
parameterType 項目の値が SigningCertificate の場合、この項目は証明書を参照します。
|
| description |
- 項目の型
- string
- 説明
- 人間が見てわかる、この外部ログイン情報パラメーターの説明。
|
| parameterGroup |
- 項目の型
- string
- 説明
- パラメーターをそれぞれのプリンシパルとともにグループ化します。たとえば、動的な範囲を使用する場合、ユーザーが範囲 AuthParameter を適用できるのは、parameterGroup 値が一致する特定のプリンシパルに対して認証されたときのみです。
parameterGroup の値が指定されていない場合、parameterGroup はデフォルトで PER_USER と NAMED_PRINCIPAL の parameterName の値に設定されます。それ以外のパラメーターの場合、parameterGroup はデフォルトで DEFAULT_GROUP に設定されます。
|
| parameterName |
- 項目の型
- string
- 説明
-
必須。
外部ログイン情報パラメーターの名前。
|
| parameterType |
- 項目の型
- ExternalCredentialParamType (string 型の列挙)
- 説明
-
必須。
外部ログイン情報パラメーターの種別。この項目の値によってパラメーターの動作が決まります。値は次のとおりです。
-
AuthHeader: ユーザーは、実行時にコールアウトに追加されるカスタム認証ヘッダーを指定できます。AuthHeader を使用する場合、parameterName 項目は文字列のヘッダー名にし、parameterValue は実行時に評価されるヘッダー値の数式にする必要があります。sequenceNumber はコールアウトでヘッダーを送信する順序を決定します。最初に番号の低いヘッダーから送信されます。
-
AuthParameter: ユーザーによる認証設定の追加を許可します。parameterName は、設定するパラメーターを定義します。たとえば、AwsRegion は AWS Signature V4 認証プロトコルに適用する AWS Region パラメーターを設定し、parameterValue は AWS リージョンの値です。
-
AuthProtocolVariant: 認証プロトコルのバリエーションを指定するために使用します。たとえば、ParameterName が AwsSv4 で ParameterValue が AwsSv4_STS の場合、Aws Sts がバリエーションになります。
-
AuthProvider: authProvider 項目で参照される認証プロバイダーをこのパラメーターで設定することを指定します。
-
AuthProviderUrl: 認証エンドポイント URL を指定します。たとえば、認証種別が OAuth with JWT Bearer Flow の場合、parameterValue が認証トークンエンドポイントになります。
-
AuthProviderUrlQueryParameter: ユーザーは、実行時に認証プロバイダーのコールアウトに追加されるカスタムクエリパラメーターを指定できます。現在、STS を使用した AWS Signature V4 のみをサポートしています。AuthProviderUrlQueryParameter で使用可能な値は、AWS STS で使用する AwsExternalId と AwsDuration です。
-
AwsStsPrincipal: AWS Signature V4 を STS とともに設定します。parameterName は AwsStsPrincipal で、parameterValue は未指定です。
-
JwtBodyClaim: JWT (JSON Web トークン) ボディクレームを指定します。parameterName はキーで、parameterValue は値です。たとえば、JWT 利用者のパラメーター名は aud です。
-
JwtHeaderClaim: JWT ヘッダークレームを指定します。parameterName はキーで、parameterValue は値です。たとえば、JWT 鍵識別子のパラメーター名は kid です。
-
NamedPrincipal: パラメーターで使用するユーザーログイン情報のセットを、外部システムにアクセスするすべてのユーザーに対して同じにすることを指定します。
-
PerUserPrincipal: 個人ユーザーレベルでのアクセス制御を提供します。
-
SigningCertificate: 認証の署名に使用する証明書を指定します。certificate 項目を使用して、証明書名を指定します。OAuth with JWT Bearer Flow と RolesAnywhere を使用した AwsSv4 STS の認証に使用します。
|
| parameterValue |
- 項目の型
- string
- 説明
-
parameterType 項目がリテラル値を示している場合、この項目にはリテラル値が保存されます。
|
| principal |
- 項目の型
- string
- 説明
-
parameterType 項目の値が NamedPrincipal または PerUserPrincipal の場合、この項目は権限セットを参照します。ログイン情報プロバイダーから提供されるログイン情報が使用可能な一連のユーザーは、その値によって決定されます。parameterName 項目の値は、このプリンシパルの名前を指定します。
-
この項目は API バージョン 56.0 で初めて使用可能になりましたが、API バージョン 58.0 以降では削除されました。
|
| sequenceNumber |
- 項目の型
- int
- 説明
- ユーザーが参加しているプリンシパルが複数あるときに適用するプリンシパルの順序を指定します。たとえば、ユーザーは、ログイン情報プロバイダーで適用される複数の権限セットに割り当てることができます。優先度は、番号の小さい方が高くなります。
この項目を設定できるのは、parameterType が NamedPrincipal の場合のみです。
|