ConnectApi.ExternalAuthIdentityProvider
External auth identity provider.
| Property Name | Type | Description | Available Version |
|---|---|---|---|
authenticationFlow | ConnectApi.IdentityProviderAuthFlow | Authentication flow to get tokens to call protected APIs. Values are:
| 62.0 |
authenticationProtocol | ConnectApi.IdentityProviderAuthProtocol | Authentication protocol required to access the external system. Values are:
| 62.0 |
authorizeUrl | String | Authorization endpoint URL for the external system. | 62.0 |
callbackUrl | String | For the Authorization Code authentication flow, the callback URL that’s used by the external system after authorization. | 62.0 |
clientAuthentication | ConnectApi.IdentityProviderClientAuth | Client authentication method that describes how credentials are sent to the authorization server. Values are:
| 63.0 |
createdByNamespace | String | Namespace of the package that created the external auth identity provider. | 62.0 |
credentials | List<ConnectApi.ExternalAuthIdentityProviderCredential> | List of the external auth identity provider credentials. | 62.0 |
description | String | Description of the external auth identity provider. | 62.0 |
fullName | String | Full name of the external auth identity provider. The full name can include a namespace prefix. | 62.0 |
id | String | External auth identity provider ID. | 62.0 |
label | String | External auth identity provider label. | 62.0 |
parameters | List<ConnectApi.ExternalAuthIdentityProviderParameter> | List of custom request parameters. | 63.0 |
standardExternalIdentityProvider | String | Reference to a standard external auth identity provider. | 63.0 |
tokenUrl | String | Token endpoint URL to retrieve tokens from the external system. Required for all OAuth 2.0 authentication flows. | 62.0 |
url | String | Connect REST API URL for the external auth identity provider. | 62.0 |
userInfoUrl | String | User info URL to retrieve user profile information from the external system. | 62.0 |
See Also