{
  "opencollection": "1.0.0",
  "info": {
    "name": "Auth0 Authentication actions AuthZenService API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "AuthZenService",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "[Experimental] Get AuthZEN PDP configuration and capabilities",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/.well-known/authzen-configuration/:store_id",
            "params": [
              {
                "name": "store_id",
                "value": "",
                "type": "path",
                "description": "The store ID for which to retrieve configuration.\nFollowing the AuthZEN spec's multi-tenant pattern, each store has its own discovery endpoint."
              }
            ]
          },
          "docs": "[Experimental] The GetConfiguration API returns metadata about the Policy Decision Point (PDP) including its name, version, supported endpoints, and capabilities. This endpoint follows the AuthZEN specification for PDP discovery.\n\nFollowing the AuthZEN spec's multi-tenant pattern, OpenFGA provides a per-store discovery endpoint at `/.well-known/authzen-configuration/{store_id}`. This returns absolute endpoint URLs specific to that store.\n\n## Example Response\n```json\n{\n  \"policy_decision_point\": "
        },
        {
          "info": {
            "name": "[Experimental] Evaluate whether a subject can perform an action on a resource",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/stores/:store_id/access/v1/evaluation",
            "params": [
              {
                "name": "store_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "[Experimental] The Evaluation API determines whether a subject is authorized to perform an action on a resource. This endpoint implements the AuthZEN Access Evaluation API specification.\n\n## Request Structure\nThe request requires three components:\n- **subject**: The entity requesting access (e.g., a user or service)\n- **action**: The operation being performed (maps to a relation in the authorization model)\n- **resource**: The object being accessed\n\nEach component has a `type` and `id` field, and"
        },
        {
          "info": {
            "name": "[Experimental] Check whether one or more users are authorized to access resources",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/stores/:store_id/access/v1/evaluations",
            "params": [
              {
                "name": "store_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "[Experimental] The Evaluations API allows batch authorization checks in a single request. It supports request-level defaults for subject, action, resource, and context that can be overridden per evaluation item.\n\n## Evaluation Semantics\nThe `options.evaluations_semantic` field controls how evaluations are processed:\n- `execute_all` (default): Execute all evaluations and return all results\n- `deny_on_first_deny`: Stop processing on first deny decision\n- `permit_on_first_permit`: Stop processing o"
        },
        {
          "info": {
            "name": "[Experimental] Search for actions a subject can perform on a resource",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/stores/:store_id/access/v1/search/action",
            "params": [
              {
                "name": "store_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "[Experimental] The ActionSearch API returns all actions (relations) that a subject can perform on a specific resource. This is useful for answering questions like \"What can Anne do with this document?\" or building dynamic UIs that show only the actions a user is permitted to perform.\n\n## Examples\n### Find all actions a user can perform on a document\n```json\n{\n  \"subject\": {\"type\": \"user\", \"id\": \"anne\"},\n  \"resource\": {\"type\": \"document\", \"id\": \"roadmap\"}\n}\n```\nResponse:\n```json\n{\n  \"results\": [\n"
        },
        {
          "info": {
            "name": "[Experimental] Search for resources a subject has access to",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/stores/:store_id/access/v1/search/resource",
            "params": [
              {
                "name": "store_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "[Experimental] The ResourceSearch API returns all resources of a given type that a subject has a specific action (relation) on. This is useful for answering questions like \"What documents can Anne read?\" or \"What folders can Bob administer?\"\n\nThe resource type filter is required. Results support pagination for large result sets.\n\n## Examples\n### Find all documents a user can read\n```json\n{\n  \"subject\": {\"type\": \"user\", \"id\": \"anne\"},\n  \"action\": {\"name\": \"can_read\"},\n  \"resource\": {\"type\": \"docu"
        },
        {
          "info": {
            "name": "[Experimental] Search for subjects with access to a resource",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{auth0_domain}/stores/:store_id/access/v1/search/subject",
            "params": [
              {
                "name": "store_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "[Experimental] The SubjectSearch API returns all subjects that have a specific action (relation) on a given resource. This is useful for answering questions like \"Who can read this document?\" or \"Who can administer this folder?\"\n\nResults can be filtered by subject type and support pagination for large result sets.\n\n## Examples\n### Find all users who can read a document\n```json\n{\n  \"resource\": {\"type\": \"document\", \"id\": \"roadmap\"},\n  \"action\": {\"name\": \"can_read\"},\n  \"subject\": {\"type\": \"user\"}\n}"
        }
      ]
    }
  ],
  "bundled": true
}