Skip to main content

Config for openlmis

Jobs that use the openlmis adaptor may require authentication. A "credential" for the openlmis 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",
  "username": "administrator",
  "baseUrl": "https://test.openlmis.org"
}

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://test.openlmis.org)",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://test.openlmis.org"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "Username",
          "examples": [
              "administrator"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Password",
          "writeOnly": true,
          "examples": [
              "@some(!)Str0ngp4ss0w0rd"
          ]
      },
      "access_token": {
          "title": "Access Token",
          "type": "string",
          "description": "Your OpenLMIS API access token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "4739f6c9-3b81-4176-98a1-bf001c8416ea"
          ]
      },
      "clientId": {
          "title": "Client ID",
          "type": "string",
          "description": "Your user based client id",
          "writeOnly": true,
          "minLength": 1,
          "default": "user-client"
      },
      "clientSecret": {
          "title": "Client Secret Token",
          "type": "string",
          "description": "Your user based client secret",
          "writeOnly": true,
          "minLength": 1,
          "default": "changeme"
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "password",
      "username",
      "baseUrl",
      "clientId",
      "clientSecret"
  ]
}