Salesforce Docs Portal

ConnectApi.ExternalCredential

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.
Important

Important

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.

Property Name Type Description Available Version
authenticationProtocol ConnectApi.​CredentialAuthentication​Protocol Authentication protocol of the external credential. Values are:
  • AwsSv4
  • Basic
  • Custom
  • Jwt
  • OAuth
 56.0
authenticationProtocol​Variant ConnectApi.​CredentialAuthentication​ProtocolVariant 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.
57.0
authenticationStatus ConnectApi.​CredentialAuthentication​Status Status of the credential authentication. 56.0
createdByNamespace String Namespace of the package that created the external credential. 59.0
customHeaders List<ConnectApi.​CredentialCustom​Header> List of custom headers. 57.0
developerName String Fully qualified developer name of the external credential. 56.0
id String External credential ID. 58.0
masterLabel String External credential label. 56.0
parameters List<ConnectApi.​ExternalCredential​Parameter> List of parameters of the external credential. 57.0
principals List<ConnectApi.​ExternalCredential​Principal> List of principals the credential has. 56.0
relatedNamed​Credentials List<ConnectApi.​NamedCredential> List of named credentials associated to the external credential. 56.0
url String Connect REST API URL for the external credential. 58.0