この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Credential

ログイン情報の取得、作成、更新、置換、または削除を行います。

リソース

1/named-credentials/credential

使用可能なバージョン

56.0

HTTP のメソッド

GET、POST、PUT、PATCH、DELETE

PATCH はバージョン 59.0 以降でカスタムプロトコルに対してのみサポートされます。

GET の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
`externalCredential`	String	外部ログイン情報の完全修飾開発者名。	必須	56.0
`principalName`	String	外部ログイン情報の指定ユーザーの名前。	`principalType` が `NamedPrincipal` の場合は必須	56.0
`principalType`	String	ログイン情報プリンシパルの種別。値は次のとおりです。 `AwsStsPrincipal` `NamedPrincipal` `PerUserPrincipal`	必須	56.0

GET のレスポンスボディ

Credential

POST の要求パラメーター

次の要求パラメーターを使用して、OAuth または AWS Roles Anywhere ログイン情報を更新します。

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
`action`	String	ログイン情報の作成時に実行するアクション。値は次のとおりです。 `Refresh`	省略可能	58.0

POST、PUT、および PATCH のリクエストボディ

次のリクエストボディを使用して、ログイン情報の作成 (POST)、置換 (PUT)、および更新 (PATCH) を行います。

ルート XML タグ

<credential>

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

1{
2externalCredential: "ecNameAws",
3authenticationProtocol: "AwsSv4",
4principalName: "principalA",
5principalType: "NamedPrincipal",
6credentials: {
7   awsAccessKeyId: {
8      value: "00000000000",
9      encrypted: false
10   },
11   awsSecretAccessKey: {
12      value: "aws-secret-value",
13      encrypted: true
14   },
15   awsRoleArn: {
16      value: "arn:partition:service:region:account-id:resource-id",
17      encrypted: false
18   }
19}
20}

ログイン情報を置換する JSON の例 (PUT)

この例では、ログイン情報に apiKey と apiSecret の 2 つの値があると仮定します。このリクエストボディが PUT で使用されると、apiKey が更新され、apiSecret が削除されます。

1{
2   authenticationProtocol: String : "Custom",
3   externalCredential: String : "medicalIntegrationExternalCredential",
4   principalName: String : "customerSupportGroup", 
5   principalType: String : "NamedPrincipal",
6   // Map<String, ConnectApi.CredentialValue>
7   credentials: { 
8       apiKey: { 
9           value: String : "00000000",
10           encrypted: Boolean : false
11       }
12   }
13}

カスタムログイン情報を更新する JSON の例 (PATCH)

PATCH はカスタムログイン情報でのみサポートされます。リクエストボディに含まれるログイン情報のみが更新されます。この例では、ログイン情報に apiKey と apiSecret の 2 つの値があると仮定します。このリクエストボディが PATCH で使用されると、apiKey が更新され、apiSecret はそのままになります。

1{
2   authenticationProtocol: String : "Custom",
3   externalCredential: String : "medicalIntegrationExternalCredential",
4   principalName: String : "customerSupportGroup", 
5   principalType: String : "NamedPrincipal",
6   // Map<String, ConnectApi.CredentialValue>
7   credentials: { 
8       apiKey: { 
9           value: String : "00000000",
10           encrypted: Boolean : false
11       }
12   }
13}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`authenticationProtocol`	String	外部ログイン情報の認証プロトコル。値は次のとおりです。 `AwsSv4` `Basic` `Custom` `Jwt` `OAuth`	必須	56.0
`authenticationProtocolVariant`	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。指定する場合は、認証プロトコルのバリエーションが実際の外部ログイン情報の認証プロトコルバリエーションと一致している必要があります。	省略可能	57.0
`credentials`	Map<String, Credential Value Input>	プロトコル固有のログイン情報の対応付け。認証プロトコルには、ログイン情報の許可リストと暗号化ルールがあります。 `AwsSv4` — `awsAccessKeyId` (暗号化なし)、`awsSecretAccessKey` (暗号化あり)、`awsRoleArn` (暗号化なし) `Custom` — 任意のログイン情報の名前が有効 (ユーザーが暗号化ルールを設定)	必須	56.0
`externalCredential`	String	外部ログイン情報の完全修飾開発者名。	必須	56.0
`principalName`	String	外部ログイン情報の指定ユーザーの名前。	`principalType` が `NamedPrincipal` の場合は必須	56.0
`principalType`	String	ログイン情報プリンシパルの種別。値は次のとおりです。 `AwsStsPrincipal` `NamedPrincipal` `PerUserPrincipal`	必須	56.0

POST、PATCH、PUT のレスポンスボディ

Credential

DELETE の要求パラメーター

パラメーター名	型	説明	必須か省略可能	使用可能なバージョン
`authenticationParameters`	String []	カスタムプロトコル専用の認証パラメーターのリスト (例: `myApiKey,myApiSecret`)。指定されていない場合、すべてのログイン情報が削除されます。	省略可能	59.0
`externalCredential`	String	外部ログイン情報の完全修飾開発者名。	必須	56.0
`principalName`	String	外部ログイン情報の指定ユーザーの名前。	`principalType` が `NamedPrincipal` の場合は必須	56.0
`principalType`	String	ログイン情報プリンシパルの種別。値は次のとおりです。 `AwsStsPrincipal` `NamedPrincipal` `PerUserPrincipal`	必須	56.0

DELETE のレスポンスボディ

204: Successful Delete

Connect REST API 開発者ガイド

Credential