ConnectApi.ExternalAuthIdentityProviderInput

External auth identity provider input.

PropertyTypeDescriptionRequired or OptionalAvailable Version
authenticationFlowConnectApi.​IdentityProvider​AuthFlowAuthentication flow to get tokens to call protected APIs. Values are:
  • AuthorizationCode
  • ClientCredentials
Required62.0
authenticationProtocolConnectApi.​IdentityProvider​AuthProtocolAuthentication protocol required to access the external system. Values are:
  • OAuth
Required62.0
authorizeUrlStringAuthorization endpoint URL for the external system.Required when the authenticationProtocol is OAuth and the authenticationFlow is AuthorizationCode. Otherwise, Optional.62.0
clientAuthenticationConnectApi.​IdentityProvider​ClientAuthClient authentication method that describes how credentials are sent to the authorization server. Values are:
  • ClientSecretBasic
  • ClientSecretPost
  • Custom

The default value is ClientSecretBasic.
Optional63.0
descriptionStringDescription of the external auth identity provider.Optional62.0
fullNameStringFull name of the external auth identity provider. The full name can include a namespace prefix.Required62.0
labelStringExternal auth identity provider label.Required62.0
parametersList<ConnectApi.​ExternalAuth​IdentityProvider​Parameter>List of custom request parameters to customize and extend requests to the identity provider’s token endpoint.Optional63.0
standardExternal​IdentityProviderStringReference to a standard external auth identity provider.Optional63.0
tokenUrlStringToken endpoint URL to retrieve tokens from the external system. Required for all OAuth 2.0 authentication flows.Required62.0
userInfoUrlStringUser info URL to retrieve user profile information from the external system.
Applicable only when the authenticationProtocol is OAuth.
Optional62.0

See Also