Config for copper

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

{
  "accessToken": "a1b2c3d4e5f6",
  "userEmail": "user@example.com"
}

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": {
      "accessToken": {
          "title": "Access Token",
          "type": "string",
          "description": "Copper API key (Settings > Integrations > API Keys)",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "a1b2c3d4e5f6"
          ]
      },
      "userEmail": {
          "title": "User Email",
          "type": "string",
          "description": "Email of the Copper user who generated the API key",
          "format": "email",
          "examples": [
              "user@example.com"
          ]
      },
      "baseUrl": {
          "title": "Base URL",
          "type": "string",
          "description": "Override the Copper API base URL. Defaults to https://api.copper.com/developer_api/v1",
          "format": "uri",
          "examples": [
              "https://api.copper.com/developer_api/v1"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "accessToken",
      "userEmail"
  ]
}