Skip to content

feat: authzen docs #1211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaguiarz merged 1 commit into from
Mar 23, 2026
Merged

feat: authzen docs #1211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/content/interacting/authzen.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ All AuthZEN endpoints return an `Unimplemented` error if the experimental flag i

## Endpoints

All AuthZEN endpoints are scoped to a store and available under `/stores/{store_id}/access/v1/`.
All AuthZEN endpoints are scoped to a store. Evaluation and search endpoints are available under `/stores/{store_id}/access/v1/`. The Get Configuration (discovery) endpoint uses a different path: `/.well-known/authzen-configuration/{store_id}`.

| Endpoint | Method | Path | Description |
|---|---|---|---|
Expand Down Expand Up @@ -87,7 +87,7 @@ The Evaluation endpoint determines whether a subject is authorized to perform an

**Request:**

```json
```http
POST /stores/{store_id}/access/v1/evaluation

{
Expand Down Expand Up @@ -155,7 +155,7 @@ The Evaluations endpoint performs batch authorization checks in a single request

**Request:**

```json
```http
POST /stores/{store_id}/access/v1/evaluations

{
Expand Down Expand Up @@ -235,7 +235,7 @@ This answers questions like "Who can read this document?"

**Request:**

```json
```http
POST /stores/{store_id}/access/v1/search/subject

{
Expand Down Expand Up @@ -270,7 +270,7 @@ This answers questions like "What documents can Anne read?"

**Request:**

```json
```http
POST /stores/{store_id}/access/v1/search/resource

{
Expand Down Expand Up @@ -305,7 +305,7 @@ This answers questions like "What can Anne do with this document?"

**Request:**

```json
```http
POST /stores/{store_id}/access/v1/search/action

{
Expand Down Expand Up @@ -426,7 +426,7 @@ The AuthZEN spec does not define a standard way to pin requests to a specific mo

### X-Request-ID header

The spec RECOMMENDS that PEPs include an `X-Request-ID` header in requests and that PDPs echo it back in responses. <ProductName format={ProductNameFormat.ShortForm}/> returns an `X-Request-Id` header in all responses but does not currently echo back client-provided request IDs.
The spec RECOMMENDS that PEPs include an `X-Request-ID` header in requests and that PDPs echo it back in responses. <ProductName format={ProductNameFormat.ShortForm}/> returns an `X-Request-ID` header in all responses but does not currently echo back client-provided request IDs.

### Contextual Tuples

Expand Down
Loading