Config for dynamics

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

{
  "resource": "https://openfn.crm2.dynamics.com",
  "apiVersion": "8.2.0",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI"
}

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#",
  "$comment": "OAuth2",
  "properties": {
      "resource": {
          "title": "Resource",
          "type": "string",
          "description": "Dynamics resource URL",
          "format": "uri",
          "minLength": 1,
          "examples": [
              "https://openfn.crm2.dynamics.com"
          ]
      },
      "apiVersion": {
          "title": "API Version",
          "type": "string",
          "default": "8.2.0",
          "description": "Dynamics API version to use",
          "minLength": 1,
          "examples": [
              "8.2.0"
          ]
      },
      "access_token": {
          "title": "Access Token",
          "type": "string",
          "description": "Dynamics API access token",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IjlGWERwYmZNRlQyU3ZRdVhoODQ2WVR3RUlCdyIsI"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "resource",
      "apiVersion",
      "access_token"
  ]
}