Config for openspp

Jobs that use the openspp adaptor may require authentication. A "credential" for the openspp 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://openspp.example.org",
  "clientId": "client_AbC123dEf456",
  "clientSecret": "@some(!)Str0ngp4ss0w0rd"
}

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 OpenSPP instance, without the API path",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://openspp.example.org"
          ]
      },
      "clientId": {
          "title": "Client ID",
          "type": "string",
          "description": "OAuth client ID of an OpenSPP API client",
          "minLength": 1,
          "examples": [
              "client_AbC123dEf456"
          ]
      },
      "clientSecret": {
          "title": "Client Secret",
          "type": "string",
          "description": "OAuth client secret of an OpenSPP API client",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@some(!)Str0ngp4ss0w0rd"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "baseUrl",
      "clientId",
      "clientSecret"
  ]
}