Salesforce · Schema

CreateNamedCredentialRequest

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
developerName string
masterLabel string
type string
calloutUrl string
externalCredentials array
customHeaders array
calloutOptions object
View JSON Schema on GitHub

JSON Schema

salesforce-create-named-credential-request-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "developerName": {
      "type": "string",
      "example": "example_value"
    },
    "masterLabel": {
      "type": "string",
      "example": "example_value"
    },
    "type": {
      "type": "string",
      "example": "example_value"
    },
    "calloutUrl": {
      "type": "string",
      "example": "https://www.example.com"
    },
    "externalCredentials": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "developerName": {
            "type": "string",
            "example": "example_value"
          }
        },
        "required": [
          "developerName"
        ]
      }
    },
    "customHeaders": {
      "type": "array",
      "description": "",
      "example": [],
      "items": {
        "type": "object",
        "properties": {
          "headerName": {
            "type": "string",
            "example": "example_value"
          },
          "headerValue": {
            "type": "string",
            "example": "example_value"
          },
          "sequenceNumber": {
            "type": "integer",
            "example": 10
          }
        },
        "required": [
          "headerName",
          "headerValue",
          "sequenceNumber"
        ]
      }
    },
    "calloutOptions": {
      "type": "object",
      "properties": {
        "allowMergeFieldsInBody": {
          "type": "boolean",
          "example": true
        },
        "allowMergeFieldsInHeader": {
          "type": "boolean",
          "example": true
        },
        "generateAuthorizationHeader": {
          "type": "boolean",
          "example": true
        }
      },
      "required": [
        "allowMergeFieldsInBody",
        "allowMergeFieldsInHeader",
        "generateAuthorizationHeader"
      ]
    }
  },
  "required": [
    "developerName",
    "masterLabel",
    "type",
    "calloutUrl",
    "externalCredentials",
    "customHeaders",
    "calloutOptions"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "CreateNamedCredentialRequest"
}