Skip to main content

Config for openfn

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

{
  "host": "https://www.openfn.org",
  "projectId": "some-id",
  "username": "test@openfn.org",
  "password": "@super(!)Secretpass"
}

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": {
      "host": {
          "title": "Host",
          "type": "string",
          "description": "The OpenFn host url",
          "format": "uri",
          "default": "https://www.openfn.org",
          "minLength": 1,
          "examples": [
              "https://www.openfn.org"
          ]
      },
      "projectId": {
          "title": "Project ID",
          "type": "string",
          "description": "Your OpenFn project ID",
          "minLength": 1,
          "examples": [
              "some-id"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "The username to log in to OpenFn",
          "minLength": 1,
          "examples": [
              "test@openfn.org"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "The password to log in to OpenFn",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@super(!)Secretpass"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "host",
      "username",
      "password"
  ]
}