NamedCredential

Represents a named credential, which specifies the URL of a callout endpoint and its required authentication parameters in one definition. A named credential can be specified as an endpoint to simplify the setup of authenticated callouts. This object is available in API version 33.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this object’s name.

Important

All credentials stored within this entity are encrypted under a framework that is consistent with other encryption frameworks on the platform. Salesforce encrypts your credentials by auto-creating org-specific keys. Credentials encrypted using the previous encryption scheme have been migrated to the new framework.

Note

Supported Calls

describeSObjects(), query(), retrieve()

Special Access Rules

As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object.

Fields

Field Name	Details
AuthProviderId	Type reference Properties Filter, Group, Nillable, Sort Description Salesforce ID of the authentication provider, which defines the service that provides the login process and approves access to the external system. Only users with the “Customize Application” and “Manage AuthProviders” permissions can view this field. This field is available in API version 39.0 and later. This is a relationship field. Relationship Name AuthProvider Relationship Type Lookup Refers To AuthProvider
AuthTokenEndpointUrl	Type textarea Properties Nillable Description The URL where SON Web Tokens (JWTs) are exchanged for access tokens. This field is available in API version 46.0 and later.
CalloutOptionsAllowMergeFieldsInBody	Type boolean Properties Filter Description For Apex callouts, indicates whether the code can use merge fields to populate HTTP request bodies with org data. This field is available in API version 35.0 and later.
CalloutOptionsAllowMergeFieldsInHeader	Type boolean Properties Filter Description For Apex callouts, indicates whether the code can use merge fields to populate HTTP headers with org data. This field is available in API version 35.0 and later.
CalloutOptionsGenerateAuthorizationHeader	Type boolean Properties Filter Description Indicates whether Salesforce automatically generates a standard authorization header for each callout to the named credential–defined endpoint. This field is available in API version 35.0 and later.
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name of the object 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. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization.
Endpoint	Type textarea Properties Nillable Description The root URL of the endpoint.
JwtAudience	Type textarea Properties Nillable Description External service or other allowed recipients for the JSON Web Token. Written as JSON, with a quoted string for a single audience and an array of quoted strings for multiple audiences. Single audience example: `“aud1”`. Multiple audiences example: `[”aud1”, “aud2”, “aud3”]`. This field is available in API version46.0 and later.
JwtFormulaSubject	Type string Properties Filter, Group, Nillable, Sort Description Formula string calculating the JSON Web Token’s subject. API names and constant strings, in single quotes, can be included. Allows a dynamic Subject unique per user requesting the token. For example, `'User='+$User.Id`. Use this field when PrincipalType is set to `PerUser`. Corresponds to Per User Subject in the user interface. This field is available in API version 46.0 and later.
JwtIssuer	Type string Properties Filter, Group, Nillable, Sort Description Specify who issued the JSON Web Token using a case-sensitive string. This field is available in API version 46.0 and later.
JwtTextSubject	Type string Properties Filter, Group, Nillable, Sort Description Static text, without quotes, that specifies the JSON Web Token subject. Use this field when PrincipalType is set to `NamedUser`. Corresponds to Named Principal Subject in the user interface. This field is available in API version 46.0 and later.
JwtValidityPeriodSeconds	Type int Properties Filter, Group, Nillable, Sort Description The number of seconds that the JSON Web Token is valid. This field is available in API version 46.0 and later.
Language	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The language of the MasterLabel.
MasterLabel	Type string Properties Filter, Group, Sort Description The label for the named credential. This display value is the internal label that doesn’t get translated.
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.
PrincipalType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Tracks users who are accessing the external system. `Anonymous` implies that a user identity isn’t specified for external system access. `Named Principal` uses one user identity for all users to access the external system.

Usage

Use the NamedCredential object to query named credentials in your organization.

Some named credential fields rely on per-user authentication to connect with an external system. If an admin edits one of these fields, then the previously authenticated credentials can get invalidated, requiring individual users to reauthenticate.