Skip to main content

Config for primero

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

{
  "url": "https://primero.org/some-org",
  "user": "admin",
  "password": "@super(!)Superpass",
  "basicAuth": "true"
}

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": {
      "url": {
          "title": "URL",
          "type": "string",
          "description": "The Primero host url",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://primero.org/some-org"
          ]
      },
      "user": {
          "title": "User",
          "type": "string",
          "description": "The username",
          "minLength": 1,
          "examples": [
              "admin"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@super(!)Superpass"
          ]
      },
      "basicAuth": {
          "title": "Use Basic Auth",
          "type": "boolean",
          "examples": [
              true
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "url"
  ]
}