External Evaluation

Create Allow or Block policies which evaluate the user based on custom criteria.

APIs.ioEngineeringPlatform

Properties

Name Type Description
external_evaluation object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-access-external-evaluation-rule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/access_external_evaluation_rule",
  "title": "External Evaluation",
  "description": "Create Allow or Block policies which evaluate the user based on custom criteria.",
  "properties": {
    "external_evaluation": {
      "properties": {
        "evaluate_url": {
          "description": "The API endpoint containing your business logic.",
          "example": "https://eval.example.com",
          "type": "string"
        },
        "keys_url": {
          "description": "The API endpoint containing the key that Access uses to verify that the response came from your API.",
          "example": "https://eval.example.com/keys",
          "type": "string"
        }
      },
      "required": [
        "evaluate_url",
        "keys_url"
      ],
      "type": "object"
    }
  },
  "required": [
    "external_evaluation"
  ],
  "type": "object"
}