---
schema_version: "1"
id: aa66f306934ee08a9dac4e32406e6391a155c323c2fbd38737eaa08751392feb
title: ConnectApi.ExternalAuthIdentityProviderInput
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_input_external_auth_identity_provider.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_input_external_auth_identity_provider.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 205d3ae87c5f09f24405d5659287baa551849e9ebc5edee5e8d29f97f63f383c
description: External auth identity provider input.
---
# ConnectApi.ExternalAuthIdentityProviderInput

External auth identity provider input.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d636488e26">Property</th>
              <th class="featureTableHeader vertical-align-top " id="d636488e28">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d636488e30">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d636488e32">Required or Optional</th>
              <th class="featureTableHeader vertical-align-top " id="d636488e34">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">authenticationFlow</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/connectAPI_enums.htm#IdentityProviderAuthFlowEnum"><samp class="codeph apex_code">ConnectApi.​IdentityProvider​AuthFlow</samp></a></td>

              <td class="entry" headers="d636488e30" data-title="Description">Authentication flow to get tokens to call protected APIs.
                Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">AuthorizationCode</samp></li>
                  <li class="li"><samp class="codeph nolang">ClientCredentials</samp></li>
                </ul>
              </td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">authenticationProtocol</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/connectAPI_enums.htm#IdentityProviderAuthProtocolEnum"><samp class="codeph apex_code">ConnectApi.​IdentityProvider​AuthProtocol</samp></a></td>

              <td class="entry" headers="d636488e30" data-title="Description">Authentication protocol required to access the external system. Values are:<ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">OAuth</samp></li>
                </ul>
              </td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">authorizeUrl</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="authorizeUrl"><a name="authorizeUrl"><!-- --></a>Authorization endpoint URL for the external
                  system.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Required when the <samp class="codeph ">authenticationProtocol</samp> is
                <samp class="codeph ">OAuth</samp> and the <samp class="codeph ">authenticationFlow</samp> is <samp class="codeph ">AuthorizationCode</samp>. Otherwise, Optional.
              </td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">clientAuthentication</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/connectAPI_enums.htm#IdentityProviderClientAuthEnum"><samp class="codeph apex_code">ConnectApi.​IdentityProvider​ClientAuth</samp></a></td>

              <td class="entry" headers="d636488e30" data-title="Description">Client authentication method that describes how credentials are sent to the
                authorization server. Values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">ClientSecretBasic</samp></li>

                  <li class="li"><samp class="codeph nolang">ClientSecretPost</samp></li>

                  <li class="li"><samp class="codeph apex_code">Custom</samp></li>

                </ul>
                <p class="p">The default value is <samp class="codeph nolang">ClientSecretBasic</samp>.</p>
              </td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">63.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">description</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="description"><a name="description"><!-- --></a>Description of the external auth identity
                  provider.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">fullName</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="fullName"><a name="fullName"><!-- --></a>Full name of the external auth identity provider. The full
                  name can include a namespace prefix.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">label</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="label"><a name="label"><!-- --></a>External auth identity provider label.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">parameters</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_methods_system_list.htm#apex_methods_system_list" title="Contains methods for the List collection type.">List</a>&lt;<a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_input_external_auth_identity_provider_parameter.htm" title="External auth identity provider parameter input."><samp class="codeph apex_code">ConnectApi.​ExternalAuth​IdentityProvider​Parameter</samp></a>&gt;
              </td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="parameters"><a name="parameters"><!-- --></a>List of custom request parameters to customize and extend
                  requests to the identity provider’s token endpoint.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">63.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">standardExternal​IdentityProvider</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="standardExternalIdentityProvider"><a name="standardExternalIdentityProvider"><!-- --></a>Reference to a standard external auth
                  identity provider.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">63.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">tokenUrl</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description"><span class="ph" id="tokenUrl"><a name="tokenUrl"><!-- --></a>Token endpoint URL to retrieve tokens from the external
                  system. Required for all OAuth 2.0 authentication flows.</span></td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Required</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

            <tr>
              <td class="entry" headers="d636488e26 d636488e34" data-title="Property"><samp class="codeph apex_code">userInfoUrl</samp></td>

              <td class="entry" headers="d636488e28" data-title="Type">String</td>

              <td class="entry" headers="d636488e30" data-title="Description">
                <span class="ph" id="userInfoUrl"><a name="userInfoUrl"><!-- --></a>User info URL to retrieve user profile information from
                  the external system.</span>
                <p class="p">Applicable only when the <samp class="codeph ">authenticationProtocol</samp> is <samp class="codeph ">OAuth</samp>.</p>
              </td>

              <td class="entry" headers="d636488e32" data-title="Required or Optional">Optional</td>

              <td class="entry" headers="d636488e26 d636488e34" data-title="Property">62.0</td>

            </tr>

          </tbody>
        </table>

#### See Also

- [createExternalAuthIdentityProvider(requestBody)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_NamedCredentials_static_methods.htm#apex_ConnectAPI_NamedCredentials_createExternalAuthIdentityProvider_2 "Create an external auth identity provider.")
- [updateExternalAuthIdentityProvider(developerName, requestBody)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_NamedCredentials_static_methods.htm#apex_ConnectAPI_NamedCredentials_updateExternalAuthIdentityProvider_3 "Update an external auth identity provider.")