Skip to main content

Config for salesforce

Jobs that use the salesforce adaptor may require authentication. A "credential" for the salesforce adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration​

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "loginUrl": "https://somesalesforcelogin.url",
  "username": "someusername",
  "password": "@super(!)SecretPass",
  "securityToken": "salesforcesecuritytoken",
  "apiVersion": "59.0"
}

Full Schema​

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "loginUrl": {
          "title": "Login URL",
          "type": "string",
          "description": "The Salesforce instance login URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://somesalesforcelogin.url"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "The username to log in the Salesforce instance",
          "minLength": 1,
          "examples": [
              "someusername"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "The password to log in the Salesforce instance",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@super(!)SecretPass"
          ]
      },
      "securityToken": {
          "title": "Security Token",
          "type": "string",
          "description": "The security token to access the Salesforce instance",
          "minLength": 1,
          "examples": [
              "salesforcesecuritytoken"
          ]
      },
      "apiVersion": {
          "title": "API Version",
          "type": "string",
          "placeholder": "52.0",
          "description": "Salesforce API Version",
          "minLength": 1,
          "examples": [
              "59.0"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "loginUrl",
      "username",
      "password"
  ]
}