Skip to main content

Config for zoho

Jobs that use the zoho adaptor may require authentication. A "credential" for the zoho 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.

{
  "account": "yourzohoaccount",
  "authToken": "secreauthtoken",
  "apiVersion": "v2"
}

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": {
      "account": {
          "title": "Account",
          "type": "string",
          "description": "Your Zoho account",
          "minLength": 1,
          "examples": [
              "yourzohoaccount"
          ]
      },
      "authToken": {
          "title": "Auth Token",
          "type": "string",
          "description": "Your Zoho authentication token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "secreauthtoken"
          ]
      },
      "apiVersion": {
          "title": "API Version",
          "type": "string",
          "default": "v2",
          "enum": [
              "v1",
              "v2"
          ],
          "description": "Zoho API version",
          "minLength": 1,
          "examples": [
              "v2",
              "v1"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "account",
      "authToken",
      "apiVersion"
  ]
}