Skip to main content

Config for mojatax

Jobs that use the mojatax adaptor may require authentication. A "credential" for the mojatax 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://vfd-staging.mojatax.com",
  "password": "@some(!)Str0ngp4ss0w0rd",
  "clientId": "the-long-uuid-provided-by-mojatax"
}

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": "Mojatax base URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://vfd-staging.mojatax.com"
          ]
      },
      "clientId": {
          "title": "Client Id",
          "type": "string",
          "description": "Your Mojatax client id",
          "examples": [
              "the-long-uuid-provided-by-mojatax"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Your Mojatax password",
          "writeOnly": true,
          "examples": [
              "@some(!)Str0ngp4ss0w0rd"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "baseUrl",
      "password",
      "clientId"
  ]
}