Skip to main content

Config for inform

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

{
  "baseUrl": "https://data.inform.unicef.org",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI"
}

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",
          "anyOf": [
              {
                  "type": "string"
              },
              {
                  "type": "null"
              }
          ],
          "description": "The base URL (https://data.inform.unicef.org)",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://data.inform.unicef.org"
          ]
      },
      "access_token": {
          "title": "Access Token",
          "type": "string",
          "description": "Your Inform access token",
          "examples": [
              "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI"
          ]
      },
      "apiVersion": {
          "title": "Api Version",
          "type": "string",
          "placeholder": "v1",
          "description": "Inform api version",
          "examples": [
              "v1"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "baseUrl",
      "access_token"
  ]
}