Named Credential

Get, update, and delete a named credential.

Resource

1/named-credentials/named-credential-setup/developerName

Available version

58.0

HTTP methods

GET, PUT, DELETE

Request body for PUT

JSON example

1{
2   "developerName": "SamplePrivate",
3   "masterLabel": "SamplePrivateLabel",
4   "type": "PrivateEndpoint",
5   "calloutUrl": "https://www.salesforce.com",
6   "externalCredentials": [
7      {
8         "developerName": "SampleAws"
9      }
10   ],
11   "networkConnection": {
12      "developerName": "SampleOutboundConnection"
13   },
14   "customHeaders": [
15      {
16         "headerName": "SampleHeader",
17         "headerValue": "SampleValue",
18         "sequenceNumber": 1
19      },
20      {
21         "headerName": "SampleHeader2",
22         "headerValue": "SampleValue2",
23         "sequenceNumber": 2
24      }
25   ],
26   "calloutOptions": {
27      "allowMergeFieldsInBody": false,
28      "allowMergeFieldsInHeader": true,
29      "generateAuthorizationHeader": true
30   },
31   "parameters": [
32      {
33         "parameterName": "NamespaceOne",
34         "parameterType": "AllowedManagedPackageNamespaces",
35         "parameterValue": "namespace1",
36         "parameterDescription": "This is a description"
37      },
38      {
39         "parameterName": "NamespaceTwo",
40         "parameterType": "AllowedManagedPackageNamespaces",
41         "parameterValue": "namespace2"
42      },
43      {
44         "parameterName": "ClientCertificate",
45         "parameterType": "ClientCertificate",
46         "parameterValue": "SampleCertificate"
47      }
48   ]
49}

Properties

Name	Type	Description	Required or Optional	Available Version
`calloutOptions`	Named Credential Callout Options Input	Callout options.	Required	58.0
`calloutUrl`	String	URL of the named credential in a callout.	Required	58.0
`customHeaders`	Credential Custom Header Input[]	Custom HTTP headers.	Optional	58.0
`developerName`	String	Named credential developer name.	Required for POST Optional for PUT	58.0
`externalCredentials`	External Credential Input[]	External credentials used by the named credential. In version 58.0 and later, only one external credential is supported.	Required	58.0
`masterLabel`	String	Named credential label.	Required	58.0
`networkConnection`	Network Connection Input	PrivateConnect outbound network connection.	Optional depending on `type`	58.0
`parameters`	Named Credential Parameter Input[]	Named credential parameters.	Optional	58.0
`type`	String	Type of named credential. Values are: `PrivateEndpoint` `SecuredEndpoint`	Required	58.0

Response body for GET and PUT

Named Credential

Response for DELETE

204: Successful Delete

Connect REST API Developer Guide

Named Credential