| authenticationProtocol |
ConnectApi.CredentialAuthenticationProtocol |
外部ログイン情報の認証プロトコル。値は次のとおりです。
- AwsSv4
- Basic
- Custom
- Jwt
- OAuth
|
必須 |
56.0 |
| authenticationProtocolVariant |
ConnectApi.CredentialAuthenticationProtocolVariant |
外部ログイン情報の認証プロトコルバリエーション。値は次のとおりです。
-
AwsSv4_STS — セキュリティトークンサービスを使用する AWS 署名バージョン 4。
-
ClientCredentialsClientSecret — OAuth 2.0 クライアントログイン情報のクライアントの秘密。クライアントの秘密は、コールアウトのリクエストボディで送信されます。
-
ClientCredentialsClientSecretBasic — OAuth 2.0 クライアントログイン情報のクライアントの秘密。クライアントの秘密は、基本認証と同様にコールアウトの認証ヘッダーで送信されます。
-
ClientCredentialsJwtAssertion — OAuth 2.0 クライアントログイン情報の JSON Web トークンアサーション。
-
JwtBearer — OAuth 2.0 JSON Web トークンフロー。
-
NoAuthentication — 認証なし。
-
RolesAnywhere — Identity and Access Management (IAM) Roles Anywhere を使用する AWS 署名バージョン 4。
指定する場合は、認証プロトコルのバリエーションが実際の外部ログイン情報の認証プロトコルバリエーションと一致している必要があります。
|
省略可能 |
57.0 |
| credentials |
Map<String, ConnectApi.CredentialValueInput> |
プロトコル固有のログイン情報の対応付け。
認証プロトコルには、ログイン情報の許可リストと暗号化ルールがあります。
-
AwsSv4 — awsAccessKeyId (暗号化なし)、awsSecretAccessKey (暗号化あり)、awsRoleArn (暗号化なし)
-
Custom — 任意のログイン情報の名前が有効 (ユーザーが暗号化ルールを設定)
|
必須 |
56.0 |
| externalCredential |
String |
外部ログイン情報の完全修飾開発者名。 |
必須 |
56.0 |
| principalName |
String |
外部ログイン情報の指定ユーザーの名前。 |
principalType が NamedPrincipal の場合は必須 |
56.0 |
| principalType |
ConnectApi.CredentialPrincipalType |
ログイン情報のユーザーの種別。値は次のとおりです。
- AwsStsPrincipal
- NamedPrincipal
- PerUserPrincipal
|
必須 |
56.0 |
j