---
schema_version: "1"
id: 4cff35edb1970bb40d2eda2bb72c2ad2b4e45f059a3397723a53fad23b37f43b
title: ConnectApi.ExternalCredentialParameter
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_connectapi_output_external_credential_parameter.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_external_credential_parameter.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 4979bbe3d57a70fe8a4e4c55275a9157878d9ac2c0dac330e61f6a4b888f85bd
description: External credential parameter.
---
# ConnectApi.ExternalCredentialParameter

External credential parameter.

<table class="featureTable sort_table" summary="">
          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader vertical-align-top " id="d976185e27">Property Name</th>
              <th class="featureTableHeader vertical-align-top " id="d976185e29">Type</th>
              <th class="featureTableHeader vertical-align-top " id="d976185e31">Description</th>
              <th class="featureTableHeader vertical-align-top " id="d976185e33">Available Version</th>
            </tr>
          </thead>
          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d976185e27" data-title="Property Name"><samp class="codeph apex_code">id</samp></td>

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

              <td class="entry" headers="d976185e31" data-title="Description">Parameter ID.</td>

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

            </tr>

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

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

              <td class="entry" headers="d976185e31" data-title="Description">Parameter description.</td>

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

            </tr>

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

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

              <td class="entry" headers="d976185e31" data-title="Description">
                <span class="ph" id="parameterName"><a name="parameterName"><!-- --></a>Parameter name. If the <samp class="codeph apex_code">parameterType</samp> is <samp class="codeph apex_code">AuthParameter</samp>, valid values are:</span><a name="ExternalCredentialAuthParameterNameEnumValues"><!-- --></a>
                <ul class="ul bulletList" id="ExternalCredentialAuthParameterNameEnumValues">
                  <li class="li">
                    <samp class="codeph apex_code">AwsAccountId</samp>—Valid for
                    AwsSv4.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">AwsProfileArn</samp>—Valid for AwsSv4
                    with RolesAnywhere.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">AwsRegion</samp>—Valid for
                    AwsSv4.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">AwsService</samp>—Valid for
                    AwsSv4.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">AwsStsDuration</samp>—Valid for AwsSv4
                    with STS or RolesAnywhere.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">AwsStsExternalId</samp>—Valid for
                    AwsSv4 with STS.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">AwsTrustAnchorArn</samp>—Valid for
                    AwsSv4 with RolesAnywhere.
                  </li>

                  <li class="li">
                    <samp class="codeph apex_code">Scope</samp>—Valid for OAuth.
                  </li>

                </ul>
                <span class="ph" id="parameterNameOtherTypes"><a name="parameterNameOtherTypes"><!-- --></a>Other parameter types can be any
                  value.</span>
              </td>

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

            </tr>

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

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

              <td class="entry" headers="d976185e31" data-title="Description">Parameter type of the external credential.</td>

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

            </tr>

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

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

              <td class="entry" headers="d976185e31" data-title="Description"><span class="ph" id="parameterValue"><a name="parameterValue"><!-- --></a>Parameter value. If the <samp class="codeph apex_code">parameterType</samp> is <samp class="codeph apex_code">JwtBodyClaim</samp>
                  or <samp class="codeph apex_code">JwtHeaderClaim</samp>, the parameter value can
                  contain formulas. If the <samp class="codeph apex_code">parameterType</samp> is
                  <samp class="codeph apex_code">AuthProvider</samp> or <samp class="codeph apex_code">SigningCertificate</samp>, the parameter value is the
                  fully qualified entity name of the corresponding entity.</span></td>

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

            </tr>

          </tbody>
        </table>

#### See Also

- [ConnectApi.ExternalCredential](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_external_credential.htm "External credential, including the named credentials and principals associated with it and the type and status of each principal.")