Skip to main content

Config for ibipimo

Jobs that use the ibipimo adaptor may require authentication. A "credential" for the ibipimo 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://demo.ibipimo.org",
  "apiToken": "your_access_token_here"
}

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": "The base URL of the IBIPIMO API server",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://demo.ibipimo.org"
          ]
      },
      "apiToken": {
          "title": "API Token",
          "type": "string",
          "description": "Bearer token for authenticating with the IBIPIMO API",
          "writeOnly": true,
          "examples": [
              "your_access_token_here"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "baseUrl",
      "apiToken"
  ]
}