Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ConnectApi.Credential

Credential.
Property Name Type Description Available Version
authentication​Protocol ConnectApi.​CredentialAuthentication​Protocol Authentication protocol of the external credential. Values are:
  • AwsSv4
  • Basic
  • Custom
  • Jwt
  • OAuth
56.0
authentication​ProtocolVariant 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
authentication​Status ConnectApi.​CredentialAuthentication​Status 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.
56.0
credentials Map<String, ConnectApi.​CredentialValue> Map of protocol-specific credentials. 56.0
externalCredential String Fully qualified developer name of the external credential. 56.0
principalName String Name of the external credential named principal. 56.0
principalType ConnectApi.​CredentialPrincipal​Type Type of credential principal. Values are:
  • AwsStsPrincipal
  • NamedPrincipal
  • PerUserPrincipal
56.0