---
schema_version: "1"
id: 02811ef62ca9bcba16e498377b965098a130f4a7cef1f90e40790deb29943d3c
title: ConnectApi.ExternalCredential
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_output_external_credential.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_external_credential.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 23ba70f81ccd6e6c87d980baf7c1b37f4210900848c3e03cbb2737691f0d189b
description: External credential, including the named credentials and principals associated with it and the type and status of each principal.
---
# ConnectApi.ExternalCredential

External credential, including the named credentials and principals associated with it and the type and status of each principal.

If you don’t have the View Setup and Configuration permission, some properties are empty or show limited information.

![Important](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/images/icon_note_important.png)

#### Important

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

<table class="featureTable sort_table" summary="">




            <thead class="thead sorted" align="left">
              <tr>
                <th class="featureTableHeader vertical-align-top " id="d974427e39">Property Name</th>

                <th class="featureTableHeader vertical-align-top " id="d974427e42">Type</th>

                <th class="featureTableHeader vertical-align-top " id="d974427e45">Description</th>

                <th class="featureTableHeader vertical-align-top " id="d974427e48">Available Version</th>

              </tr>

            </thead>

            <tbody class="tbody">
              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">authenticationProtocol</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">Authentication protocol of the external credential. Values are:<ul class="ul bulletList">
                    <li class="li"><samp class="codeph apex_code">AwsSv4</samp></li>
                    <li class="li"><samp class="codeph apex_code">Basic</samp></li>
                    <li class="li"><samp class="codeph apex_code">Custom</samp></li>
                    <li class="li"><samp class="codeph apex_code">Jwt</samp></li>
                    <li class="li"><samp class="codeph apex_code">OAuth</samp></li>
                  </ul>
                </td>

                <td class="entry" headers="d974427e48" data-title="Available Version">56.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">authenticationProtocol​Variant</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">Authentication protocol variant of the external credential. Values are:<ul class="ul bulletList">
                    <li class="li">
                      <samp class="codeph apex_code">AwsSv4_STS</samp>—AWS Signature Version 4 with Security Token Service.
                    </li>
                    <li class="li">
                      <samp class="codeph apex_code">ClientCredentialsClientSecret</samp>—OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s request body.
                    </li>
                    <li class="li">
                      <samp class="codeph apex_code">ClientCredentialsClientSecretBasic</samp>—OAuth 2.0 Client Credentials client secret. Client secrets are sent in the callout’s authorization header, as with Basic authentication.
                    </li>
                    <li class="li">
                      <samp class="codeph apex_code">ClientCredentialsJwtAssertion</samp>—OAuth 2.0 Client Credentials JSON Web Token assertion.
                    </li>
                    <li class="li">
                      <samp class="codeph apex_code">JwtBearer</samp>—OAuth 2.0 JSON Web Token bearer flow.
                    </li>
                    <li class="li">
                      <samp class="codeph apex_code">NoAuthentication</samp>—No authentication.
                    </li>
                    <li class="li">
                      <samp class="codeph apex_code">RolesAnywhere</samp>—AWS Signature Version 4 with Identity and Access Management (IAM) Roles Anywhere.
                    </li>
                  </ul>
                </td>

                <td class="entry" headers="d974427e48" data-title="Available Version">57.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">authenticationStatus</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">Status of the credential authentication.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">56.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">createdByNamespace</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description"><span class="ph" id="createdByNamespace"><a name="createdByNamespace"><!-- --></a>Namespace of the package that created the external
                    credential.</span></td>

                <td class="entry" headers="d974427e48" data-title="Available Version">59.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">customHeaders</samp></td>

                <td class="entry" headers="d974427e42" 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_output_credential_custom_header.htm" title="Credential custom header."><samp class="codeph apex_code">ConnectApi.​CredentialCustom​Header</samp></a>&gt;
                </td>

                <td class="entry" headers="d974427e45" data-title="Description"><span class="ph" id="customHeaders"><a name="customHeaders"><!-- --></a>List of custom headers.</span></td>

                <td class="entry" headers="d974427e48" data-title="Available Version">57.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">developerName</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">Fully qualified developer name of the external credential.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">56.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">id</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">External credential ID.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">58.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">masterLabel</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">External credential label.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">56.0</td>

              </tr>

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

                <td class="entry" headers="d974427e42" 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_output_external_credential_parameter.htm" title="External credential parameter."><samp class="codeph nolang">ConnectApi.​ExternalCredential​Parameter</samp></a>&gt;
                </td>

                <td class="entry" headers="d974427e45" data-title="Description"><span class="ph" id="parameters"><a name="parameters"><!-- --></a>List of parameters of the external credential.</span></td>

                <td class="entry" headers="d974427e48" data-title="Available Version">57.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">principals</samp></td>

                <td class="entry" headers="d974427e42" 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_output_external_credential_principal.htm" title="External credential principal."><samp class="codeph apex_code">ConnectApi.​ExternalCredential​Principal</samp></a>&gt;
                </td>

                <td class="entry" headers="d974427e45" data-title="Description">List of principals the credential has.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">56.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">relatedNamed​Credentials</samp></td>

                <td class="entry" headers="d974427e42" 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_output_named_credential.htm" title="Named credential associated with an external credential."><samp class="codeph apex_code">ConnectApi.​NamedCredential</samp></a>&gt;
                </td>

                <td class="entry" headers="d974427e45" data-title="Description">List of named credentials associated to the external credential.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">56.0</td>

              </tr>

              <tr>
                <td class="entry" headers="d974427e39" data-title="Property Name"><samp class="codeph apex_code">url</samp></td>

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

                <td class="entry" headers="d974427e45" data-title="Description">Connect REST API URL for the external credential.</td>

                <td class="entry" headers="d974427e48" data-title="Available Version">58.0</td>

              </tr>

            </tbody>

          </table>

#### See Also

- [ConnectApi.ExternalCredentialList](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_external_credential_list.htm "List of external credentials.")
- [ConnectApi.NamedCredential](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_named_credential.htm "Named credential associated with an external credential.")