ConnectApi.Credential

Credential.

Property NameTypeDescriptionAvailable Version
authentication​ProtocolConnectApi.​CredentialAuthentication​ProtocolAuthentication protocol of the external credential. Values are:
  • AwsSv4
  • Basic
  • Custom
  • Jwt
  • OAuth
56.0
authentication​ProtocolVariantConnectApi.​CredentialAuthentication​ProtocolVariantAuthentication 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​StatusConnectApi.​CredentialAuthentication​StatusStatus of the credential authentication.56.0
credentialsMap<String, ConnectApi.​CredentialValue>Map of protocol-specific credentials.56.0
externalCredentialStringFully qualified developer name of the external credential.56.0
principalNameStringName of the external credential named principal.56.0
principalTypeConnectApi.​CredentialPrincipal​TypeType of credential principal. Values are:
  • AwsStsPrincipal
  • NamedPrincipal
  • PerUserPrincipal
56.0