--- schema_version: "1" id: 5b7812bdd738df188c678dab5a7d36995f4bba9cb35c462ea136d45f627737e0 title: ExternalAuthIdentityProvider collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_externalauthidentityprovider.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_externalauthidentityprovider.htm source_site: developer.salesforce.com content_type: documentation content_hash: 259af81f20006d59729b0fd18f113cedca9b85b0ce0fe14b6032ad0088fd462b description: Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems. --- # ExternalAuthIdentityProvider Represents an external authentication (auth) identity provider. An external auth identity provider links to an external credential and obtains OAuth tokens for outbound callouts to external systems. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/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. ## Supported SOAP API Calls create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert() ## Supported REST API Methods DELETE, GET, HEAD, PATCH, POST, Query ## Special Access Rules Only users with the Customize Application permission or the Manage Named Credentials permission can access this object. ## Fields | Field | Details | | --- | --- | | AuthenticationFlow | Type picklist Properties Filter, Group, Restricted picklist, Sort Description Authentication flow to get tokens to call protected APIs. Possible values are: - AuthorizationCode - ClientCredentials - SalesforceDefined | | AuthenticationProtocol | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The authentication protocol that’s required to access the external system. Possible values are: - OAuth - SalesforceDefined | | Description | Type string Properties Filter, Group, Nillable, Sort Description A meaningful description of the external auth identity provider. | | DeveloperName | Type string Properties Filter, Group, Sort Description The unique internal name for the named credential used in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is automatically generated, but you can supply your own value if you create the record using the API. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow while Salesforce generates one for each record. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/images/icon_note.png) #### Note Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. | | FullName | Type string Properties Create, Group, Nillable Description The full name of the associated type in Tooling API. The full name can include a namespace prefix. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | Language | Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description The language of the external auth identity provider. | | ManageableState | Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: - beta - deleted - deprecated - deprecatedEditable - installed - installedEditable - released - unmanaged | | MasterLabel | Type string Properties Filter, Group, Sort Description Label for the external auth identity provider. In the UI, this field is **Label**. | | Metadata | Type complexvalue Properties Create, Nillable, Update Description Provides access to the associated metadata type and related fields in Tooling API. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. | | NamespacePrefix | Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix\_\_componentName notation. | ## ExternalAuthIdentityProviderParameter Represents the parameters that configure an external auth identity provider. | Field | Details | | --- | --- | | Description | Type string Properties Filter, Group, Nillable, Sort Description A human-readable description of the external auth identity provider parameter. | | ManageableState | Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: - beta - deleted - deprecated - deprecatedEditable - installed - installedEditable - released - unmanaged | | ParameterName | Type string Properties Filter, Group, Sort Description The name of the external auth identity provider parameter. | | ParameterType | Type picklist Properties Filter, Group, Restricted picklist, Sort Description The type of external auth identity provider parameter. The value of this field drives the behavior of the parameter. Possible values are: - AuthorizeRequestQueryParameter - AuthorizeUrl - ClientAuthentication - CreatedByNamespace - IdentityProviderOptions - ManagedByComponent - ManagedByFeature - RefreshRequestBodyParameter - RefreshRequestHttpHeader - RefreshRequestQueryParameter - StandardExternalIdentityProvider - TokenRequestBodyParameter - TokenRequestHttpHeader - TokenRequestQueryParameter - TokenUrl - UserInfoUrl | | ParameterValue | Type textarea Properties Nillable Description If the parameterType field describes a literal value then the literal value is stored in this field. | | SequenceNumber | Type int Properties Filter, Group, Nillable, Sort Description Specifies the order of parameters to apply when an external auth identity provider has more than one parameter. Priority is from lower to higher numbers (for example, 1 is the highest priority). |