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

指定ログイン情報

ログイン情報の取得、作成、更新、および削除を行います。

リソース

1/named-credentials/credential

使用可能なバージョン

56.0

Chatter が必要かどうか

いいえ

HTTP のメソッド

GET、POST、PUT、DELETE

GET および DELETE の要求パラメータ

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

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

ルート XML タグ

<credential>

JSON の例

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}

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`authenticationProtocol`	String	外部ログイン情報の認証プロトコル。値は次のとおりです。 `AwsSv4` `Custom` `OAuth`	必須	56.0
`authenticationProtocolVariant`	String	外部ログイン情報の認証プロトコルバリエーション。値は次のとおりです。 `AwsSv4_STS` — セキュリティトークンサービスを使用する AWS 署名バージョン 4。 `JwtBearer` — OAuth 2.0 JSON Web トークンフロー。 `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

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

Credential

DELETE のレスポンスボディ

204: Successful Delete

Connect REST API 開発者ガイド

指定ログイン情報