Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.CredentialInput

Credential input.
Property Type Description Required or Optional Available Version
authentication​Protocol ConnectApi.​Credential​Authentication​Protocol Authentication protocol of the external credential. Values are:
  • AwsSv4
  • Custom
  • OAuth
Required 56.0
credentials Map<String, ConnectApi.​Credential​ValueInput> Map of protocol-specific credentials.
Authentication protocols have credential allowlists and encryption rules.
  • AwsSv4awsAccessKeyId (not encrypted), awsSecretAccessKey (encrypted), awsRoleArn (not encrypted)
  • Custom—Any credential name is valid (user sets encryption rules)
Required 56.0
externalCredential String Developer name of the external credential. Required 56.0
principalName String Name of the external credential named principal. Required if principalType is NamedPrincipal 56.0
principalType ConnectApi.​Credential​Principal​Type Type of credential principal. Values are:
  • AwsStsPrincipal
  • NamedPrincipal
  • PerUserPrincipal
Required 56.0