Skip to main content

Config for odk

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

{
  "password": "@some(!)Str0ngp4ss0w0rd",
  "email": "test@openfn.org",
  "baseUrl": "https://sandbox.getodk.cloud/"
}

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": {
      "baseUrl": {
          "title": "Base URL",
          "type": "string",
          "description": "ODK base URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://sandbox.getodk.cloud/"
          ]
      },
      "email": {
          "title": "Email",
          "type": "string",
          "description": "Email",
          "examples": [
              "test@openfn.org"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Password",
          "writeOnly": true,
          "examples": [
              "@some(!)Str0ngp4ss0w0rd"
          ]
      },
      "access_token": {
          "title": "Access Token",
          "type": "string",
          "description": "Your ODK access token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "the-long-access-token-from-your-auth"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "password",
      "email",
      "baseUrl"
  ]
}