feat: AuthZen docs

[aaguiarz]

Description

• Adds a new docs/content/interacting/authzen.mdx page documenting OpenFGA's
  implementation of the AuthZEN specification — a standard API for authorization
  interoperability defined by the OpenID AuthZEN working group.
• Covers:
  • How to enable the experimental authzen flag
  • All six endpoints: Evaluation, Evaluations (batch), Subject Search, Resource Search,
    Action Search, and Get Configuration
  • Request/response examples for each endpoint
  • Mapping between AuthZEN concepts and OpenFGA concepts (subject → user/userset, action →
    relation, resource → object)
  • Specifying an authorization model via header
  • Contextual tuples support
• Adds the "AuthZEN API" entry to the sidebar under Interacting.

What problem is being solved?

How is it being solved?

What changes are made to solve it?

References

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

• Documentation
  • Added documentation for the experimental AuthZEN interoperability API covering feature enablement, endpoint routes and discovery, request/response structures with ABAC support, batch evaluation semantics and execution strategies, search capabilities and constraints, implementation notes for multi-tenant deployments, model pinning, request tracking, and current limitations.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e0578769-3daf-47aa-91bb-67d24b9a046b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

A new AuthZEN interoperability API documentation page is added to explain enabling the feature via flags, endpoint routes, request/response structures, batch evaluation semantics, search functionality, and implementation-specific notes. The sidebar navigation is updated to include this new documentation entry.

Changes

Cohort / File(s)	Summary
AuthZEN Documentation docs/content/interacting/authzen.mdx, docs/sidebars.js	Added comprehensive AuthZEN API documentation covering configuration, endpoint specifications (/stores/{store_id}/access/v1/), Evaluation/Evaluations endpoints with ABAC support, search semantics, and implementation details including multi-tenancy path handling and request header extensions. Updated sidebar to include AuthZEN API documentation entry.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested reviewers

• dyeam0
• ttrzeng

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'feat: AuthZen docs' directly and accurately describes the main change: adding documentation for the AuthZEN API. It is concise, specific, and clearly communicates the primary modification.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/authzen-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-23 15:16 UTC

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/content/interacting/authzen.mdx`:
- Around line 415-417: Update the docs to stop saying the `page` field is
"accepted but ignored" and instead add a prominent warning in each search
endpoint section (where `next_token`, `page`, and pagination are discussed) that
the API does not support pagination and the `page` parameter is unsupported;
explicitly instruct users to rely on opaque `next_token` if/when supported or
expect all results in a single response, and remove/replace any wording in the
`Pagination` paragraph that implies `page` is accepted to avoid misleading
users.
- Around line 427-429: The documentation uses two different casings for the same
header ("X-Request-ID" vs "X-Request-Id"); verify the actual implementation
behavior (the header returned by <ProductName/>) and then update the text so
both occurrences use the exact same header string (replace "X-Request-ID" or
"X-Request-Id" so they match the implementation) and ensure the ProductName
sentence references that same casing consistently throughout the doc.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0002f2aa-a881-45d4-beab-47666b7f8e32

📥 Commits

Reviewing files that changed from the base of the PR and between 4d1dac2 and 0f10ff6.

📒 Files selected for processing (2)

• docs/content/interacting/authzen.mdx
• docs/sidebars.js

[Copilot]

Pull request overview

Adds a new documentation page describing OpenFGA’s experimental AuthZEN API implementation and exposes it in the Docusaurus sidebar under “Interacting with the API”.

Changes:

• Added docs/content/interacting/authzen.mdx covering AuthZEN endpoints, examples, and implementation notes.
• Added “AuthZEN API” to docs/sidebars.js under the “Interacting with the API” section.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 11 comments.

File	Description
docs/sidebars.js	Adds a sidebar entry pointing to the new AuthZEN doc page.
docs/content/interacting/authzen.mdx	New MDX page documenting AuthZEN endpoints, behavior, and OpenFGA mapping.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[rhamzeh]

Approved, but moving to draft so we don't accidentally merge it until openfga/openfga#2875 is released