{
"sections": [
"title",
"description",
"fields",
"special_access_rules",
"usage",
"wsdl_segment",
"field_reference"
],
"title": "NamedCredential - Data API",
"description": "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.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"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 a relationship field. This field is only valid for legacy named credentials. This field was first available in API version 39.0, this field is deprecated in API version 56.0.",
"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 only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0."
},
"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. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field."
},
"Endpoint": {
"type": "textarea",
"properties": "Nillable",
"description": "The root URL of the endpoint.This field is only valid for legacy named credentials. This field is deprecated in API version 56.0."
},
"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 only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0."
},
"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 only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0."
},
"JwtIssuer": {
"type": "string",
"properties": "Filter, Group, Nillable, Sort",
"description": "Specify who issued the JSON Web Token using a case-sensitive string. This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0."
},
"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 only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0."
},
"JwtValidityPeriodSeconds": {
"type": "int",
"properties": "Filter, Group, Nillable, Sort",
"description": "The number of seconds that the JSON Web Token is valid.This field is only valid for legacy named credentials. This field was first available in API version 46.0, this field is deprecated in API version 56.0."
},
"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.This field is only valid for legacy named credentials. This field is deprecated in API version 56.0."
}
},
"special_access_rules": "As of Spring ’20 and later, only users with the View Setup and Configuration permission can access this object.",
"usage": "Use the NamedCredential object to query named credentials in your organization.\n\nSome named credential fields rely on per-user authentication to connect with an\n\t\t\t\texternal system. If an admin edits one of these fields, then the previously\n\t\t\t\tauthenticated credentials can get invalidated, requiring individual users to\n\t\t\t\treauthenticate.",
"wsdl_segment": "```xml\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n\n```",
"field_reference": {
"AuthProviderId": {
"field_label": "Authentication Provider ID",
"type": "reference",
"length": "18"
},
"AuthTokenEndpointUrl": {
"field_label": "Auth Token Endpoint URL",
"type": "textarea",
"length": "1000"
},
"CalloutOptionsAllowMergeFieldsInBody": {
"field_label": "AllowMergeFieldsInBody",
"type": "boolean"
},
"CalloutOptionsAllowMergeFieldsInHeader": {
"field_label": "AllowMergeFieldsInHeader",
"type": "boolean"
},
"CalloutOptionsGenerateAuthorizationHeader": {
"field_label": "GenerateAuthorizationHeader",
"type": "boolean"
},
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"Description": {
"field_label": "Description",
"type": "string",
"length": "255"
},
"DeveloperName": {
"field_label": "Name",
"type": "string",
"length": "80"
},
"Endpoint": {
"field_label": "URL",
"type": "textarea",
"length": "1000"
},
"Id": {
"field_label": "Named Credential ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"JwtAudience": {
"field_label": "JWT Audience(s)",
"type": "textarea",
"length": "1000"
},
"JwtFormulaSubject": {
"field_label": "JWT Formula Subject",
"type": "string",
"length": "255"
},
"JwtIssuer": {
"field_label": "JWT Issuer",
"type": "string",
"length": "255"
},
"JwtTextSubject": {
"field_label": "JWT Text Subject",
"type": "string",
"length": "255"
},
"JwtValidityPeriodSeconds": {
"field_label": "JWT Validity Period in Seconds",
"type": "int",
"digits": "9"
},
"Language": {
"field_label": "Master Language",
"type": "picklist",
"length": "40"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"MasterLabel": {
"field_label": "Label",
"type": "string",
"length": "80"
},
"NamespacePrefix": {
"field_label": "Namespace Prefix",
"type": "string",
"length": "15"
},
"PrincipalType": {
"field_label": "Identity Type",
"type": "picklist",
"length": "255"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits"
]
}