Newer Version Available

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

ConnectApi.ExternalAuthIdentityProviderInput

External auth identity provider input.
Property Type Description Required or Optional Available Version
authenticationFlow ConnectApi.​IdentityProvider​AuthFlow Authentication flow to get tokens to call protected APIs. Values are:
  • AuthorizationCode
Required 62.0
authenticationProtocol ConnectApi.​IdentityProvider​AuthProtocol Authentication protocol required to access the external system. Values are:
  • OAuth
Required 62.0
authorizeUrl String Authorization endpoint URL for the external system. Required when the authenticationProtocol is OAuth and the authenticationFlow is AuthorizationCode. Otherwise, Optional. 62.0
description String Description of the external auth identity provider. Optional 62.0
fullName String Full name of the external auth identity provider. The full name can include a namespace prefix. Required 62.0
label String External auth identity provider label. Required 62.0
tokenUrl String Token endpoint URL to retrieve tokens from the external system. Required for all OAuth 2.0 authentication flows. Required 62.0
userInfoUrl String User info URL to retrieve user profile information from the external system.

Applicable only when the authenticationProtocol is OAuth.

Optional 62.0