External Credentials

POST は、バージョン 58.0 以降で使用できます。

外部ログイン情報を作成する場合の JSON の例 (POST)

1{
2   "developerName": "SampleAws",
3   "masterLabel": "SampleAwsLabel",
4   "authenticationProtocol": "AwsSv4",
5   "authenticationProtocolVariant": "AwsSv4_STS",
6   "parameters": [
7      {
8         "parameterName": "AwsService",
9         "parameterType": "AuthParameter",
10         "parameterValue": "dynamodb"
11      },
12      {
13         "parameterName": "AwsRegion",
14         "parameterType": "AuthParameter",
15         "parameterValue": "us-west-2"
16      },
17      {
18         "parameterName": "AwsAccountId",
19         "parameterType": "AuthParameter",
20         "parameterValue": "sampleAccountId"
21      },
22      {
23         "parameterName": "AwsStsExternalId",
24         "parameterType": "AuthProviderUrlQueryParameter",
25         "parameterValue": "sampleExternalId"
26      },
27      {
28         "parameterName": "AwsStsDuration",
29         "parameterType": "AuthProviderUrlQueryParameter",
30         "parameterValue": "1000"
31      }
32   ],
33   "principals": [
34      {
35         "principalName": "SamplePrincipal",
36         "principalType": "NamedPrincipal",
37         "sequenceNumber": 1
38      }
39   ],
40   "customHeaders": [
41      {
42         "headerName": "SampleHeader",
43         "headerValue": "SampleHeaderValue",
44         "sequenceNumber": 1
45      }
46   ]
47}

外部ログイン情報を更新する場合の JSON の例 (PUT)

1{
2   "developerName": "SampleOAuth",
3   "masterLabel": "SampleOAuthLabel",
4   "authenticationProtocol": "OAuth",
5   "authenticationProtocolVariant": "JwtBearer",
6   "parameters": [
7      {
8         "id": "0puxxxxxxxxxxxxxxx",
9         "parameterName": "SigningCertificate",
10         "parameterType": "SigningCertificate",
11         "parameterValue": "SampleCertificate"
12      },
13      {
14         "parameterName": "AuthProviderUrl",
15         "parameterType": "AuthProviderUrl",
16         "parameterValue": "www.identityprovider.com"
17      },
18      {
19         "parameterDescription": "Expiration Time",
20         "parameterName": "exp",
21         "parameterType": "JwtBodyClaim",
22         "parameterValue": "{!Text(FLOOR((NOW() - DATETIMEVALUE( \"1970-01-01 00:00:00\" )) * 86400 + 120))}"
23      },
24      {
25         "parameterName": "Scope",
26         "parameterType": "AuthParameter",
27         "parameterValue": "SampleScope"
28      }
29   ],
30   "principals": [
31      {
32         "principalName": "SamplePerUserPrincipal",
33         "principalType": "PerUserPrincipal",
34         "sequenceNumber": 1,
35         "parameters": [
36            {
37               "parameterName": "Scope",
38               "parameterType": "AuthParameter",
39               "parameterValue": "SamplePrincipalGroupScope"
40            }
41         ]
42      }
43   ],
44   "customHeaders": [
45      {
46         "headerName": "SampleHeader",
47         "headerValue": "SampleHeaderValue",
48         "sequenceNumber": 1
49      }
50   ]
51}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
authentication​Protocol	String	外部ログイン情報の認証プロトコル。値は次のとおりです。 AwsSv4 Basic Custom Jwt OAuth	必須	58.0
authentication​ProtocolVariant	String	外部ログイン情報の認証プロトコルバリエーション。値は次のとおりです。 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。 指定する場合は、認証プロトコルのバリエーションが実際の外部ログイン情報の認証プロトコルバリエーションと一致している必要があります。	省略可能	58.0
customHeaders	Credential Custom Header Input[]	ログイン情報のカスタムヘッダーのリスト。	省略可能	58.0
developerName	String	外部ログイン情報の完全修飾開発者名。	POST では必須 PUT では省略可能	58.0
masterLabel	String	外部ログイン情報の表示ラベル。	必須	58.0
parameters	External Credential Parameter Input[]	外部ログイン情報パラメーターのリスト。	authenticationProtocol および authenticationVariant に応じて省略可能	58.0
principals	External Credential Principal Input[]	ログイン情報に含まれるプリンシパルのリスト。	省略可能	58.0