Apex Reference Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
ConnectApi.ExternalAuthIdentityProviderInput
External auth identity provider input.
| Property | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| authenticationFlow | ConnectApi.IdentityProviderAuthFlow | Authentication flow to get tokens to call protected APIs.
Values are:
|
Required | 62.0 |
| authenticationProtocol | ConnectApi.IdentityProviderAuthProtocol | Authentication protocol required to access the external system. Values are:
|
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 |
| clientAuthentication | ConnectApi.IdentityProviderClientAuth | Client authentication method that describes how credentials are sent to the authorization server.
Values are:
The default value is ClientSecretBasic. |
Optional | 63.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 |
| parameters | List<ConnectApi.ExternalAuthIdentityProviderParameter> | List of custom request parameters to customize and extend requests to the identity provider’s token endpoint. | Optional | 63.0 |
| standardExternalIdentityProvider | String | Reference to a standard external auth identity provider. | Optional | 63.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 |