External Credential

External credential, including the named credentials and principals associated with it and the type and status of each principal.

If you don’t have the View Setup and Configuration permission, some properties are empty or show limited information.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Property Name	Type	Description	Filter Group and Version	Available Version
`authenticationProtocol`	String	Authentication protocol of the external credential. Values are: `AwsSv4` `Basic` `Custom` `Jwt` `OAuth`	Small, 56.0	56.0
`authenticationProtocolVariant`	String	Authentication protocol variant of the external credential. Values are: `AwsSv4_STS`—AWS Signature Version 4 with Security Token Service. `ClientCredentialsClientSecret`—OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body. `ClientCredentialsClientSecretBasic`—OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication. `ClientCredentialsJwtAssertion`—OAuth 2.0 Client Credentials JSON Web Token assertion. `JwtBearer`—OAuth 2.0 JSON Web Token bearer flow. `NoAuthentication`—No authentication. `RolesAnywhere`—AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere.	Small, 57.0	57.0
`authenticationStatus`	String	Status of the credential authentication. Values are: `Configured`—Credential has all required credentials for at least one principal. `NotConfigured`—Credential isn’t configured. `Unknown`—Credential status can’t be determined because the authentication protocol is custom.	Small, 56.0	56.0
`createdByNamespace`	String	Namespace of the package that created the external credential.	Small, 59.0	59.0
`customHeaders`	Credential Custom Header[]	List of custom headers.	Medium, 57.0	57.0
`developerName`	String	Fully qualified developer name of the external credential.	Small, 56.0	56.0
`id`	String	External credential ID.	Small, 58.0	58.0
`masterLabel`	String	External credential label.	Small, 56.0	56.0
`parameters`	External Credential Parameter[]	List of parameters of the external credential.	Medium, 57.0	57.0
`principals`	External Credential Principal[]	List of principals the credential has.	Medium, 56.0	56.0
`relatedNamedCredentials`	Named Credential[]	List of named credentials associated to the external credential.	Medium, 56.0	56.0
`url`	String	Connect REST API URL for the external credential.	Small, 58.0	58.0

Connect REST API Developer Guide

External Credential

See Also