Config for ping

Jobs that use the ping adaptor may require authentication. A "credential" for the ping 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": "test@openfn.org",
  "baseUrl": "https://msawe-primes-ping-bau-uat-apimgmt.azure-api.net",
  "clientId": "1234567890",
  "scope": "https://primespingb2cuat.onmicrosoft.com/apimurls/API.Read",
  "subscriptionKey": "1234567890abcdef"
}

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 Ping base URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://msawe-primes-ping-bau-uat-apimgmt.azure-api.net"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "Your Ping Username",
          "examples": [
              "test@openfn.org"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Your Ping Password",
          "writeOnly": true,
          "examples": [
              "@some(!)Str0ngp4ss0w0rd"
          ]
      },
      "clientId": {
          "title": "Client ID",
          "type": "string",
          "description": "Your Ping Client ID",
          "examples": [
              "1234567890"
          ]
      },
      "tokenUrl": {
          "title": "Token URL",
          "type": "string",
          "description": "The Ping Token URL",
          "format": "uri",
          "default": "https://primespingb2cuat.b2clogin.com",
          "examples": [
              "https://primespingb2cuat.b2clogin.com"
          ]
      },
      "scope": {
          "title": "Scope",
          "type": "string",
          "description": "Your Ping scope",
          "default": "https://primespingb2cuat.onmicrosoft.com/apimurls/API.Read",
          "examples": [
              "https://primespingb2cuat.onmicrosoft.com/apimurls/API.Read"
          ]
      },
      "subscriptionKey": {
          "title": "Subscription Key",
          "type": "string",
          "description": "Your Ping Subscription Key",
          "examples": [
              "1234567890abcdef"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "password",
      "username",
      "baseUrl",
      "clientId",
      "scope",
      "subscriptionKey"
  ]
}