Skip to main content

Config for mogli

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

{
  "loginUrl": " https://www.orange-or-airtel-or-vodafone.com/api/",
  "username": "admin",
  "password": "@secret(!)Pass",
  "securityToken": "dGF5bG9yOnNlY3JldA==",
  "secret": "someotherThiNGfSECret"
}

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": {
      "loginUrl": {
          "title": "Login URL",
          "type": "string",
          "description": "Mogli instance login URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              " https://www.orange-or-airtel-or-vodafone.com/api/"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "Mogli instance username",
          "minLength": 1,
          "examples": [
              "admin"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Mogli instance password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@secret(!)Pass"
          ]
      },
      "securityToken": {
          "title": "Security Token",
          "type": "string",
          "description": "Mogli instance security token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "dGF5bG9yOnNlY3JldA=="
          ]
      },
      "secret": {
          "title": "Secret",
          "type": "string",
          "description": "Mogli instance secret",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "someotherThiNGfSECret"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "loginUrl",
      "username",
      "password",
      "securityToken",
      "secret"
  ]
}