Skip to main content

Config for khanacademy

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

{
  "email": "test@openfn.org",
  "password": "@some(!)Strongpassword",
  "secretKey": "otherThiNGfSECret",
  "consumerKey": "somEThINGkeyish"
}

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": {
      "email": {
          "title": "Email",
          "type": "string",
          "description": "Your Khanacademy login email",
          "format": "email",
          "minLength": 1,
          "examples": [
              "test@openfn.org"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Your Khanacademy login password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@some(!)Strongpassword"
          ]
      },
      "consumerKey": {
          "title": "Consumer Key",
          "type": "string",
          "description": "Your Khanacademy consumer key",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "somEThINGkeyish"
          ]
      },
      "secretKey": {
          "title": "Secret Key",
          "type": "string",
          "description": "Your Khanacademy secret key",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "otherThiNGfSECret"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "email",
      "password",
      "secretKey",
      "consumerKey"
  ]
}