ConnectApi.ExternalAuthIdentityProvider

External auth identity provider.

Property NameTypeDescriptionAvailable Version
authenticationFlowConnectApi.​IdentityProvider​AuthFlowAuthentication flow to get tokens to call protected APIs. Values are:
  • AuthorizationCode
  • ClientCredentials
62.0
authenticationProtocolConnectApi.​IdentityProvider​AuthProtocolAuthentication protocol required to access the external system. Values are:
  • OAuth
62.0
authorizeUrlStringAuthorization endpoint URL for the external system.62.0
callbackUrlStringFor the Authorization Code authentication flow, the callback URL that’s used by the external system after authorization.62.0
clientAuthenticationConnectApi.​IdentityProvider​ClientAuthClient authentication method that describes how credentials are sent to the authorization server. Values are:
  • ClientSecretBasic
  • ClientSecretPost
  • Custom
63.0
createdByNamespaceStringNamespace of the package that created the external auth identity provider.62.0
credentialsList<ConnectApi.​ExternalAuth​IdentityProvider​Credential>List of the external auth identity provider credentials.62.0
descriptionStringDescription of the external auth identity provider.62.0
fullNameStringFull name of the external auth identity provider. The full name can include a namespace prefix.62.0
idStringExternal auth identity provider ID.62.0
labelStringExternal auth identity provider label.62.0
parametersList<ConnectApi.​ExternalAuth​IdentityProvider​Parameter>List of custom request parameters.63.0
standardExternal​IdentityProviderStringReference to a standard external auth identity provider.63.0
tokenUrlStringToken endpoint URL to retrieve tokens from the external system. Required for all OAuth 2.0 authentication flows.62.0
urlStringConnect REST API URL for the external auth identity provider.62.0
userInfoUrlStringUser info URL to retrieve user profile information from the external system.62.0

See Also