External Auth Identity Providers

Get a list of external auth identity providers in the org. Create an external auth identity provider.

Resource

1/named-credentials/external-auth-identity-providers

Available version

62.0

HTTP methods

GET, POST

Response body for GET

External Auth Identity Provider List

Request body for POST

Root XML tag

<externalAuthIdentityProvider>

JSON example

To create an external auth identity provider, you must also use the POST method with the /named-credentials/external-auth-identity-provider-credentials/fullName resource to populate the identity provider's credentials.

1{
2    "label": "ExternalIdp2",
3    "fullName": "ExternalIdp2",
4    "description": "OAuth Browser flow for connected app",
5    "authenticationProtocol": "OAuth",
6    "authenticationFlow": "AuthorizationCode",
7    "clientAuthentication": "ClientSecretPost",
8    "authorizeUrl": "https://identityprovider.com/services/oauth2/authorize",
9    "tokenUrl": "https://identityprovider.com/services/oauth2/token",
10    "userInfoUrl": "https://identityprovider.com/services/userinfo",
11    "parameters": [
12        {
13            "parameterName": "PkceEnabled",
14            "parameterType": "IdentityProviderOptions",
15            "parameterValue": "true"
16        },
17        {
18            "parameterName": "ExampleName",
19            "parameterType": "AuthorizeRequestQueryParameter",
20            "parameterValue": "ExampleValue",
21            "sequenceNumber": 1
22        }
23    ]
24}

Properties

Name	Type	Description	Required or Optional	Available Version
`authenticationFlow`	String	Authentication flow to get tokens to call protected APIs. Values are: `AuthorizationCode`	Required	62.0
`authenticationProtocol`	String	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
`clientAuthentication`	String	Client authentication method that describes how credentials are sent to the authorization server. Values are: `ClientSecretBasic` `ClientSecretPost` Defaults to `ClientSecretBasic`.	Optional	63.0
`description`	String	External auth identity provider description.	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`	External Auth Identity Provider Parameter Input[]	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

Response body for POST

External Auth Identity Provider

Connect REST API Developer Guide

External Auth Identity Providers