azapi September 2025
Gazitt, et al. Standards Track [Page]
Workgroup:
OpenID AuthZEN
Published:
Authors:
O. Gazitt, Ed.
Aserto
D. Brossard, Ed.
Axiomatics
A. Tulshibagwale, Ed.
SGNL

Authorization API 1.0 – draft 04

Abstract

The Authorization API enables Policy Decision Points (PDPs) and Policy Enforcement Points (PEPs) to communicate authorization requests and decisions to each other without requiring knowledge of each other's inner workings. The Authorization API is served by the PDP and is called by the PEP. The Authorization API includes evaluation endpoints, which provide specific access decisions, and search endpoints for discovering permissible subjects, resources, or actions.

▲

Table of Contents

1. Introduction

Computational services often implement access control within their components by separating Policy Decision Points (PDPs) from Policy Enforcement Points (PEPs). PDPs and PEPs are defined in XACML ([XACML]) and NIST's ABAC SP 800-162 ([NIST.SP.800-162]). Communication between PDPs and PEPs follows similar patterns across different software and services that require or provide authorization information. The Authorization API described in this document enables different providers to offer PDP and PEP capabilities without having to bind themselves to one particular implementation of a PDP or PEP.

2. Model

The Authorization API is a transport-agnostic API published by the PDP, to which the PEP acts as a client. Possible bindings of this specification, such as HTTPS or gRPC, are described in Transport (Section 12).

Authentication for the Authorization API itself is out of scope for this document, since authentication for APIs is well-documented elsewhere. Support for OAuth 2.0 ([RFC6749]) is RECOMMENDED.

3. Features

The core feature of the Authorization API is the Access Evaluation API, which enables a PEP to determine whether a specific request can be permitted to access a specific resource. The following are non-normative examples:

The Access Evaluations API enables execution of multiple evaluations in a single request. The following are non-normative examples:

The Search APIs provide lists of resources, subjects or actions that would be allowed access. The following are non-normative examples:

4. API Version

This document describes the API version 1.0. Any updates to this API through subsequent revisions of this document or other documents MAY augment this API, but MUST NOT modify the API described here. Augmentation MAY include additional API methods or additional parameters to existing API methods, additional authorization mechanisms, or additional optional headers in API requests. All API methods for version 1.0 MUST be immediately preceded by the relative URL path /v1/.

5. Information Model

The information model for requests and responses include the following entities: Subject, Action, Resource, Context, and Decision. These are all defined below.

5.1. Subject

A Subject is the user or machine principal about whom the Authorization API is being invoked. The Subject may be requesting access at the time the Authorization API is invoked.

A Subject is a JSON object (Section 4 of [RFC8259]) that contains two REQUIRED keys, type and id, which have a string value, and an OPTIONAL key, properties, with a value of a JSON object.

type:

REQUIRED. A string value that specifies the type of the Subject.

id:

REQUIRED. A string value containing the unique identifier of the Subject, scoped to the type.

properties:

OPTIONAL. A JSON object which can be used to express additional attributes of a Subject.

5.1.1. Subject Properties

Many authorization systems are stateless, and expect the client (PEP) to pass in all relevant attributes used in the evaluation of the authorization policy. To satisfy this requirement, Subjects MAY include additional attributes as key-value pairs, under the properties object. A property can contain any JSON value as described in Section 3 of [RFC8259]).

Examples of subject attributes can include, but are not limited to:

  • department,

  • group memberships,

  • device identifier,

  • IP address.

5.1.2. Examples (non-normative)

The following is a non-normative example of a minimal Subject:

{
  "type": "user",
  "id": "alice@example.com"
}
Figure 1: Example Subject

The following is a non-normative example of a Subject which adds a string-valued department property:

{
  "type": "user",
  "id": "alice@example.com",
  "properties": {
    "department": "Sales"
  }
}
Figure 2: Example Subject with Additional Property

The following is a non-normative example of a subject which adds IP address and device identifier properties:

{
  "type": "user",
  "id": "alice@example.com",
  "properties": {
    "ip_address": "172.217.22.14",
    "device_id": "8:65:ee:17:7e:0b"
  }
}
Figure 3: Example Subject with IP Address and Device ID

5.2. Resource

A Resource is the target of an access request. It is a JSON object (Section 4 of [RFC8259]) that is constructed similar to a Subject entity. It has the following keys:

type:

REQUIRED. A string value that specifies the type of the Resource.

id:

REQUIRED. A string value containing the unique identifier of the Resource, scoped to the type.

properties:

OPTIONAL. A JSON object which can be used to express additional attributes of a Resource.

5.2.1. Resource Properties

Similarly to the Subject properties, the PEP can also provide attributes for the Resource in the properties field.

Such attributes can include, but are not limited to, attributes of the resource used in access evaluations or metadata about the resource.

5.2.2. Examples (non-normative)

The following is a non-normative example of a Resource with a type and a simple id:

{
  "type": "book",
  "id": "123"
}
Figure 4: Example Resource

The following is a non-normative example of a Resource containing a library_record property, that is itself a JSON object:

{
  "type": "book",
  "id": "123",
  "properties": {
    "library_record":{
      "title": "AuthZEN in Action",
      "isbn": "978-0593383322"
    }
  }
}
Figure 5: Example Resource with Additional Property

5.3. Action

An Action is the type of access that the requester intends to perform.

Action is a JSON object (Section 4 of [RFC8259]) that contains a REQUIRED name key with a string value, and an OPTIONAL properties key with a JSON object value.

name:

REQUIRED. The name of the Action.

properties:

OPTIONAL. A JSON object which can be used to express additional attributes of an Action.

5.3.1. Action Properties

Similarly to the Subject and Resource properties, the PEP can also provide attributes for the Action in the properties field.

Such attributes can include, but are not limited to, parameters of the action that is being requested.

5.3.2. Examples (non-normative)

The following is a non-normative example of an action:

{
  "name": "can_read"
}
Figure 6: Example Action

The following is a non-normative example of an action with additional properties:

{
  "name": "extend-loan",
  "properties": {
    "period": "2W"
  }
}
Figure 7: Example Action with properties for extending a book loan.

5.4. Context

The Context represents the environment of the access evaluation request.

Context is a JSON object (Section 4 of [RFC8259]) which can be used to express attributes of the environment.

Examples of context attributes can include, but are not limited to:

  • The time of day,

  • Location from which the request was received,

  • Capabilities of the PEP,

  • JSON Schema or JSON-LD definitions for the request.

5.4.1. Examples (non-normative)

The following is a non-normative example of a Context:

{
  "time": "1985-10-26T01:22-07:00"
}
Figure 8: Example Context

The following example of a Context provides a JSON Schema definition which can be used to parse and validate the AuthZEN request:

{
  "time": "1985-10-26T01:22-07:00",
  "schema": "https://schema.example.com/access-request.schema.json"
}
Figure 9: Example Context with a reference to a JSON schema

5.5. Decision

A Decision is the result of the evaluation of an access request. It provides the information required for the PEP to enforce the decision.

Decision is a JSON object (Section 4 of [RFC8259]) that contains a REQUIRED decision key with a boolean value, and an OPTIONAL context key with a JSON object value.

decision:

REQUIRED. A boolean value that specifies whether the Decision is to allow or deny the operation.

context:

OPTIONAL. A JSON object which can convey additional information that can be used by the PEP as part of the decision enforcement process.

In this specification, assuming the evaluation was successful, there are only two possible values for the decision:

  • true: The access request is permitted to go forward. If the PEP does not understand information in the context response object, the PEP MAY choose to reject the decision.

  • false: The access request is denied and MUST NOT be permitted to go forward.

The following is a non-normative example of a minimal Decision:

{
  "decision": true
}
Figure 10: Example Decision

5.5.1. Decision Context

In addition to a decision, a response MAY contain a context field which can be any JSON object. This context can convey additional information that can be used by the PEP as part of the decision enforcement process.

Examples include, but are not limited to:

  • Reason(s) a decision was made,

  • "Advices" and/or "Obligations" tied to the access decision,

  • Hints for rendering UI state,

  • Instructions for step-up authentication,

  • Environmental information,

  • etc.

5.5.2. Examples (non-normative)

The following are all non-normative examples of possible and valid contexts, provided to illustrate possible usages. The actual semantics and format of the context object are an implementation concern and outside the scope of this specification. For example, implementations MAY use keys that correspond to concepts from other standards, such as HTTP status codes, to convey common reasons in an interoperable manner.

5.5.2.1. Non-normative Example 1: conveying decision Reasons

The PDP may provide reasons to explain a decision. In the non-normative example below, an implementation might convey different reasons to administrators and end-users, using keys that could correspond to HTTP status codes:

{
  "decision": false,
  "context": {
    "reason_admin": {
      "403": "Request failed policy C076E82F"
    },
    "reason_user": {
      "403": "Insufficient privileges. Contact your administrator"
    }
  }
}
Figure 11: Non-normative Example Response with reason Context
5.5.2.2. Non-normative Example 2: conveying metadata and environmental elements

In the following non-normative example, the PDP justifies its decision by including environmental conditions that did not meet its policies. Metadata pertaining to the decision response times is also provided:

{
  "decision": false,
  "context": {
    "metadata": {
      "response-time": 60,
      "response-time-unit": "ms"
    },
    "environment": {
      "ip": "10.10.0.1",
      "datetime": "2025-06-27T18:03:07Z",
      "os": "ubuntu24.04.2LTS-AMDx64"
    }
  }
}
Figure 12: Non-normative Example Response with Environment and Metadata Context
5.5.2.3. Non-normative Example 3: requesting step-up authentication

In the following non-normative example, the PDP requests a step-up authentication of the requesting subject, by signalling the required acr and amr access token claim values it expects to see in order to approve the request:

{
  "decision": false,
  "context": {
    "acr_values": "urn:com:example:loa:3",
    "amr_values": "mfa hwk"
  }
}
Figure 13: Non-normative Example Response with a step-up request Context

6. Access Evaluation API

The Access Evaluation API defines the message exchange pattern between a client (PEP) and an authorization service (PDP) for executing a single access evaluation.

6.1. The Access Evaluation API Request

The Access Evaluation request is an object consisting of four entities previously defined in the Information Model (Section 5):

subject:

REQUIRED. The subject (or principal) of type Subject

action:

REQUIRED. The action (or verb) of type Action.

resource:

REQUIRED. The resource of type Resource.

context:

OPTIONAL. The context (or environment) of type Context.

6.1.1. Example (non-normative) 

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "resource": {
    "type": "account",
    "id": "123"
  },
  "action": {
    "name": "can_read",
    "properties": {
      "method": "GET"
    }
  },
  "context": {
    "time": "1985-10-26T01:22-07:00"
  }
}
Figure 14: Example Request

6.2. The Access Evaluation API Response

The response of the Access Evaluation API consists of the Decision entity as defined in the Information Model (Section 5).

7. Access Evaluations API

The Access Evaluations API defines the message exchange pattern between a client (PEP) and an authorization service (PDP) for evaluating multiple access evaluations within the scope of a single message exchange (also known as "boxcarring" requests).

7.1. The Access Evaluations API Request

The Access Evaluation API Request builds on the information model presented in Section 5 and the object defined in the Access Evaluation Request (Section 6.1).

To send multiple access evaluation requests in a single message, the caller MAY add an evaluations key to the request. The evaluations key is an array which contains a list of JSON objects, each typed as the object as defined in the Access Evaluation Request (Section 6.1), and specifying a discrete request.

If an evaluations array is NOT present or is empty, the Access Evaluations Request behaves in a backwards-compatible manner with the (single) Access Evaluation API Request (Section 6.1).

If an evaluations array IS present and contains one or more objects, these form distinct requests that the PDP will evaluate. These requests are independent from each other, and may be executed sequentially or in parallel, left to the discretion of each implementation.

The top-level subject, action, resource, and context keys provide default values for their respective fields in the evaluations array. The top-level subject, action and resource keys MAY be omitted if the evaluations array is present, contains one or more objects, and every object in the evaluations array contains the respective top-level key. This behavior is described in Section 7.1.1.

The following is a non-normative example for specifying three requests, with no default values:

{
  "evaluations": [
    {
      "subject": {
        "type": "user",
        "id": "alice@example.com"
      },
      "action": {
        "name": "can_read"
      },
      "resource": {
        "type": "document",
        "id": "boxcarring.md"
      },
      "context": {
        "time": "2024-05-31T15:22-07:00"
      }
    },
    {
      "subject": {
        "type": "user",
        "id": "alice@example.com"
      },
      "action": {
        "name": "can_read"
      },
      "resource": {
        "type": "document",
        "id": "subject-search.md"
      },
      "context": {
        "time": "2024-05-31T15:22-07:00"
      }
    },
    {
      "subject": {
        "type": "user",
        "id": "alice@example.com"
      },
      "action": {
        "name": "can_read"
      },
      "resource": {
        "type": "document",
        "id": "resource-search.md"
      },
      "context": {
        "time": "2024-05-31T15:22-07:00"
      }
    }
  ]
}

7.1.1. Default values

While the example above provides the most flexibility in specifying distinct values in each request for every evaluation, it is common for boxcarred requests to share one or more values of the evaluation request. For example, evaluations MAY all refer to a single subject, and/or have the same contextual (environmental) attributes.

Default values offer a more compact syntax that avoids over-duplication of request data.

The top-level subject, action, resource, and context keys provide default values for each object in the evaluations array. Any of these keys specified within an individual evaluation object overrides the corresponding top-level default. Because subject, action, and resource are required for a valid evaluation, any of these keys omitted from an evaluation object MUST be provided as a top-level key.

The following is a non-normative example for specifying three requests that refer to a single subject and context:

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "context": {
    "time": "2024-05-31T15:22-07:00"
  },
  "evaluations": [
    {
      "action": {
        "name": "can_read"
      },
      "resource": {
        "type": "document",
        "id": "boxcarring.md"
      }
    },
    {
      "action": {
        "name": "can_read"
      },
      "resource": {
        "type": "document",
        "id": "subject-search.md"
      }
    },
    {
      "action": {
        "name": "can_read"
      },
      "resource": {
        "type": "document",
        "id": "resource-search.md"
      }
    }
  ]
}

The following is a non-normative example for specifying three requests that refer to a single subject and context, with a default value for action, that is overridden by the third request:

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "context": {
    "time": "2024-05-31T15:22-07:00"
  },
  "action": {
    "name": "can_read"
  },
  "evaluations": [
    {
      "resource": {
        "type": "document",
        "id": "boxcarring.md"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "subject-search.md"
      }
    },
    {
      "action": {
        "name": "can_edit"
      },
      "resource": {
        "type": "document",
        "id": "resource-search.md"
      }
    }
  ]
}

7.1.2. Evaluations options

The evaluations request payload includes an OPTIONAL options key, with a value that is a JSON object.

This provides a general-purpose mechanism for providing caller-supplied metadata on how the request is to be executed.

One such option controls evaluation semantics, and is described in Section 7.1.2.1.

A non-normative example of the options field is shown below, following an evaluations array provided for the sake of completeness:

{
  "evaluations": [{
    "resource": {
      "type": "doc",
      "id": "1"
    },
    "subject": {
      "type": "doc",
      "id": "2"
    }
  }],
  "options": {
    "evaluations_semantic": "execute_all",
    "another_option": "value"
  }
}
7.1.2.1. Evaluations semantics

By default, every request in the evaluations array is executed and a response returned in the same array order. This is the most common use-case for boxcarring multiple evaluation requests in a single payload.

This specification supports three evaluation semantics:

  1. Execute all of the requests (potentially in parallel), return all of the results. Any failure can be denoted by "decision": false and MAY provide a reason code in the context.

  2. Deny on first denial (or failure). This semantic could be desired if a PEP wants to issue a few requests in a particular order, with any denial (error, or "decision": false) "short-circuiting" the evaluations call and returning on the first denial. This essentially works like the && operator in programming languages.

  3. Permit on first permit. This is the converse "short-circuiting" semantic, working like the || operator in programming languages.

To select the desired evaluation semantic, a caller can pass in options.evaluations_semantic with exactly one of the following values:

  • execute_all

  • deny_on_first_deny

  • permit_on_first_permit

execute_all is the default semantic, so an evaluations request without the options.evaluations_semantic flag will execute using this semantic.

7.1.2.1.1. Example: Evaluate read action for three documents using all three semantics

Execute all requests:

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "action": {
    "name": "read"
  },
  "options": {
    "evaluations_semantic": "execute_all"
  },
  "evaluations": [
    {
      "resource": {
        "type": "document",
        "id": "1"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "2"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "3"
      }
    }
  ]
}

Response:

{
  "evaluations": [
    {
      "decision": true
    },
    {
      "decision": false
    },
    {
      "decision": true
    }
  ]
}

Deny on first deny:

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "action": {
    "name": "read"
  },
  "options": {
    "evaluations_semantic": "deny_on_first_deny"
  },
  "evaluations": [
    {
      "resource": {
        "type": "document",
        "id": "1"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "2"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "3"
      }
    }
  ]
}

Response:

{
  "evaluations": [
    {
      "decision": true
    },
    {
      "decision": false,
      "context": {
        "code": "200",
        "reason": "deny_on_first_deny"
      }
    }
  ]
}

Permit on first permit:

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "action": {
    "name": "read"
  },
  "options": {
    "evaluations_semantic": "permit_on_first_permit"
  },
  "evaluations": [
    {
      "resource": {
        "type": "document",
        "id": "1"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "2"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "3"
      }
    }
  ]
}

Response:

{
  "evaluations": [
    {
      "decision": true
    }
  ]
}

7.2. Access Evaluations API Response

Like the request format, the Access Evaluations Response format for an Access Evaluations Request adds an evaluations array that lists the decisions in the same order they were provided in the evaluations array in the request. Each value of the evaluations array is typed as a Decision as defined in the Information Model (Section 5).

In case the evaluations array is present, it is RECOMMENDED that the decision key of the response be omitted. If present, it can be ignored by the caller.

The following is a non-normative example of a Access Evaluations Response to an Access Evaluations Request containing three evaluation objects:

{
  "evaluations": [
    {
      "decision": true
    },
    {
      "decision": false,
      "context": {
        "reason": "resource not found"
      }
    },
    {
      "decision": false,
      "context": {
        "reason": "Subject is a viewer of the resource"
      }
    }
  ]
}

7.2.1. Errors

There are two types of errors, and they are handled differently: 1. Transport-level errors, or errors that pertain to the entire payload. 2. Errors in individual evaluations.

The first type of error is handled at the transport level. For example, for the HTTP binding, the 4XX and 5XX codes indicate a general error that pertains to the entire payload, as described in Transport (Section 12).

The second type of error is handled at the payload level. Decisions default to closed (i.e. false), but the context field can include errors that are specific to that request.

The following is a non-normative example of a response to an Access Evaluations Request containing three evaluation objects, two of them demonstrating how errors can be returned for two of the evaluation requests:

{
  "evaluations": [
    {
      "decision": true
    },
    {
      "decision": false,
      "context": {
        "error": {
          "status": 404,
          "message": "Resource not found"
        }
      }
    },
    {
      "decision": false,
      "context": {
        "reason": "Subject is a viewer of the resource"
      }
    }
  ]
}

8. Subject Search API

The Subject Search API defines the message exchange pattern between a client (PEP) and an authorization service (PDP) for returning all of the subjects that match the search criteria.

The Subject Search API is based on the Access Evaluation information model, but omits the Subject ID.

8.1. Subject Search Semantics

While the evaluation of a search is implementation-specific, it is expected that any returned results that are then fed into an evaluation call MUST result in a "decision": true response.

In addition, it is RECOMMENDED that a subject search is performed transitively, traversing intermediate attributes and/or relationships. For example, if the members of group G are designated as viewers on a document D, then a search for all users that are viewers of document D will include all the members of group G.

8.2. The Subject Search API Request

The Subject Search request is an object consisting of the following entities:

subject:

REQUIRED. The subject (or principal) of type Subject. NOTE that the Subject type is REQUIRED but the Subject ID can be omitted, and if present, is IGNORED.

action:

REQUIRED. The action (or verb) of type Action.

resource:

REQUIRED. The resource of type Resource.

context:

OPTIONAL. Contextual data about the request.

page:

OPTIONAL. A page token for paged requests.

8.2.1. Example (non-normative)

The following payload defines a request for the subjects of type user that can perform the can_read action on the resource of type account and ID 123.

{
  "subject": {
    "type": "user"
  },
  "action": {
    "name": "can_read"
  },
  "resource": {
    "type": "account",
    "id": "123"
  },
  "context": {
    "time": "2024-10-26T01:22-07:00"
  }
}
Figure 15: Example Request

8.3. The Subject Search API Response

The response is a paged array of Subjects.

{
  "results": [
    {
      "type": "user",
      "id": "alice@example.com"
    },
    {
      "type": "user",
      "id": "bob@example.com"
    }
  ],
  "page": {
    "next_token": ""
  }
}

8.3.1. Paged requests

A response that needs to be split across page boundaries returns a non-empty page.next_token.

8.3.1.1. Example 
{
  "results": [
    {
      "type": "user",
      "id": "alice@example.com"
    },
    {
      "type": "user",
      "id": "bob@example.com"
    }
  ],
  "page": {
    "next_token": "alsehrq3495u8"
  }
}

To retrieve the next page, provide page.next_token in the next request:

{
  "subject": {
    "type": "user"
  },
  "action": {
    "name": "can_read"
  },
  "resource": {
    "type": "account",
    "id": "123"
  },
  "context": {
    "time": "2024-10-26T01:22-07:00"
  },
  "page": {
    "next_token": "alsehrq3495u8"
  }
}

Note: page size is implementation-dependent.

9. Resource Search API

The Resource Search API defines the message exchange pattern between a client (PEP) and an authorization service (PDP) for returning all of the resources that match the search criteria.

The Resource Search API is based on the Access Evaluation information model, but omits the Resource ID.

9.1. Resource Search Semantics

While the evaluation of a search is implementation-specific, it is expected that any returned results that are then fed into an evaluation call MUST result in a decision: true response.

In addition, it is RECOMMENDED that a resource search is performed transitively, traversing intermediate attributes and/or relationships. For example, if user U is a viewer of folder F that contains a set of documents, then a search for all documents that user U can view will include all of the documents in folder F.

9.2. The Resource Search API Request

The Resource Search request is an object consisting of the following entities:

subject:

REQUIRED. The subject (or principal) of type Subject.

action:

REQUIRED. The action (or verb) of type Action.

resource:

REQUIRED. The resource of type Resource. NOTE that the Resource type is REQUIRED but the Resource ID is omitted, and if present, is IGNORED.

context:

OPTIONAL. Contextual data about the request.

page:

OPTIONAL. A page token for paged requests.

9.2.1. Example (non-normative)

The following payload defines a request for the resources of type account on which the subject of type user and ID alice@example.com can perform the can_read action.

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "action": {
    "name": "can_read"
  },
  "resource": {
    "type": "account"
  }
}
Figure 16: Example Request

9.3. The Resource Search API Response

The response is a paged array of Resources.

{
  "results": [
    {
      "type": "account",
      "id": "123"
    },
    {
      "type": "account",
      "id": "456"
    }
  ],
  "page": {
    "next_token": ""
  }
}

9.3.1. Paged requests

A response that needs to be split across page boundaries returns a non-empty page.next_token.

9.3.1.1. Example 
{
  "results": [
    {
      "type": "account",
      "id": "123"
    },
    {
      "type": "account",
      "id": "456"
    }
  ],
  "page": {
    "next_token": "alsehrq3495u8"
  }
}

To retrieve the next page, provide page.next_token in the next request:

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "action": {
    "name": "can_read"
  },
  "resource": {
    "type": "account"
  },
  "page": {
    "next_token": "alsehrq3495u8"
  }
}

Note: page size is implementation-dependent.

10. Action Search API

The Action Search API defines the message exchange pattern between a client (PEP) and an authorization service (PDP) for returning all of the actions that match the search criteria.

The Action Search API is based on the Access Evaluation information model, but omits the Action.

10.1. Action Search Semantics

While the evaluation of a search is implementation-specific, it is expected that any returned results that are then fed into an evaluation call MUST result in a decision: true response.

10.2. The Action Search API Request

The Action Search request is an object consisting of the following entities:

subject:

REQUIRED. The subject (or principal) of type Subject.

resource:

REQUIRED. The resource of type Resource.

context:

OPTIONAL. Contextual data about the request.

page:

OPTIONAL. A page token for paged requests.

Note: Unlike the Subject and Resource Search APIs, the action key is omitted from the Action Search request payload.

10.2.1. Example (non-normative)

The following payload defines a request for the actions that the subject of type user with ID 123 may perform on the resource of type account and ID 123 at 01:22 AM.

{
  "subject": {
    "type": "user",
    "id": "123"
  },
  "resource": {
    "type": "account",
    "id": "123"
  },
  "context": {
    "time": "2024-10-26T01:22-07:00"
  }
}
Figure 17: Example Request

10.3. The Action Search API Response

The response is a paged array of Actions.

{
  "results": [
    {
      "name": "can_read"
    },
    {
      "name": "can_write"
    }
  ],
  "page": {
    "next_token": ""
  }
}
Figure 18: Example Response

10.3.1. Paged requests

A response that needs to be split across page boundaries returns a non-empty page.next_token.

10.3.1.1. Example 
{
  "results": [
    {
      "name": "can_read"
    },
    {
      "name": "can_write"
    }
  ],
  "page": {
    "next_token": "alsehrq3495u8"
  }
}
Figure 19: Example Paged Response

To retrieve the next page, provide page.next_token in the next request:

{
  "subject": {
    "type": "user",
    "id": "123"
  },
  "resource": {
    "type": "account",
    "id": "123"
  },
  "context": {
    "time": "2024-10-26T01:22-07:00"
  },
  "page": {
    "next_token": "alsehrq3495u8"
  }
}
Figure 20: Example Paged Request

Note: page size is implementation-dependent.

11. Policy Decision Point Metadata

It is RECOMMENDED that Policy Decision Points provide metadata describing their configuration.

11.1. Data structure

The following Policy Decision Point metadata parameters are used by this specification and are registered in the IANA "AuthZEN PDP Metadata" registry established in Section 14.1.

11.1.1. Endpoint Parameters

policy_decision_point:

REQUIRED. The Policy Decision Point's identifier, which is a URL that uses the "https" scheme and has no query or fragment components. Policy Decision Point metadata is published at a location that is ".well-known" according to [RFC8615] derived from this Policy Decision Point identifier, as described in Section 11.2. The Policy Decision Point identifier is used to prevent Policy Decision Point mix-up attacks.

access_evaluation_endpoint:

REQUIRED. URL of Policy Decision Point Access Evaluation API endpoint

access_evaluations_endpoint:

OPTIONAL. URL of Policy Decision Point Access Evaluations API endpoint

search_subject_endpoint:

OPTIONAL. URL of Policy Decision Point Search API endpoint for subject element

search_action_endpoint:

OPTIONAL. URL of Policy Decision Point Search API endpoint for action element

search_resource_endpoint:

OPTIONAL. URL of Policy Decision Point Search API endpoint for resource element

capabilities:

OPTIONAL. JSON array containing a list of registered IANA URNs referencing PDP specific capabilities.

Note: the absence of any of these parameters is sufficient for the Policy Enforcement Point to determine that the Policy Decision Point is not capable and therefore will not return a result for the associated API.

11.1.2. Signature Parameter

In addition to JSON elements, metadata values MAY also be provided as a signed_metadata value, which is a JSON Web Token [RFC7519] that asserts metadata values about the Policy Decision Point as a bundle. A set of metadata parameters that can be used in signed metadata as claims are defined in Section 11.1.1. The signed metadata MUST be digitally signed or MACed using JSON Web Signature [RFC7515] and MUST contain an iss (issuer) claim denoting the party attesting to the claims in the signed metadata.

Consumers of the metadata MAY ignore the signed metadata if they do not support this feature. If the consumer of the metadata supports signed metadata, metadata values conveyed in the signed metadata MUST take precedence over the corresponding values conveyed using plain JSON elements. Signed metadata is included in the Policy Decision Point metadata JSON object using this OPTIONAL metadata parameter:

signed_metadata:

A JWT containing metadata parameters about the protected resource as claims. This is a string value consisting of the entire signed JWT. A signed_metadata parameter SHOULD NOT appear as a claim in the JWT; it is RECOMMENDED to reject any metadata in which this occurs.

11.2. Obtaining Policy Decision Point Metadata

Policy Decision Points supporting metadata MUST make a JSON document containing metadata as specified in Section 11.1.1 available at a URL formed by inserting a well-known URI string between the host component and the path and/or query components, if any. The well-known URI string used is /.well-known/authzen-configuration.

The syntax and semantics of .well-known are defined in [RFC8615]. The well-known URI path suffix used is registered in the IANA "Well-Known URIs" registry [IANA.well-known-uris].

An example of a Policy Decision Point service supporting multiple tenants will have a discovery endpoint as follows:

https://pdp.example.com/.well-known/authzen-configuration/tenant1

11.2.1. Policy Decision Point Metadata Request

A Policy Decision Point metadata document MUST be queried using an HTTP GET request at the previously specified URL. The consumer of the metadata would make the following request when the resource identifier is https://pdp.example.com:

GET /.well-known/authzen-configuration HTTP/1.1
Host: pdp.example.com

11.2.2. Policy Decision Point Metadata Response

The response is a set of metadata parameters about the protected resource's configuration. A successful response MUST use the 200 OK HTTP status code and return a JSON object using the application/json content type that contains a set of metadata parameters as its members that are a subset of the metadata parameters defined in Section 11.1.1. Additional metadata parameters MAY be defined and used; any metadata parameters that are not understood MUST be ignored.

Parameters with multiple values are represented as JSON arrays. Parameters with zero values MUST be omitted from the response.

An error response uses the applicable HTTP status code value.

The following is a non-normative example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "policy_decision_point": "https://pdp.example.com",
  "access_evaluation_endpoint": "https://pdp.example.com/access/v1/evaluation",
  "search_subject_endpoint": "https://pdp.example.com/access/v1/search/subject",
  "search_resource_endpoint": "https://pdp.example.com/access/v1/search/resource"
}

11.2.3. Policy Decision Point Metadata Validation

The policy_decision_point value returned MUST be identical to the Policy Decision Point identifier value into which the well-known URI string was inserted to create the URL used to retrieve the metadata. If these values are not identical, the data contained in the response MUST NOT be used.

The recipient MUST validate that any signed metadata was signed by a key belonging to the issuer and that the signature is valid. If the signature does not validate or the issuer is not trusted, the recipient SHOULD treat this as an error condition.

12. Transport

This specification defines an HTTPS binding which MUST be implemented by a compliant PDP.

Additional transport bindings (e.g. gRPC) MAY be defined in the future in the form of profiles, and MAY be implemented by a PDP.

12.1. HTTPS Binding

12.1.1. HTTPS Access Evaluation Request

The Access Evaluation Request is made via an HTTPS POST request. The request MUST include a Content-Type header with the value application/json. The request body MUST be a JSON object that conforms to the Access Evaluation Request structure, as defined in Section 6.1.

The request URL MUST be the value of the access_evaluation_endpoint parameter if it is provided in the PDP Metadata (Section 11.1.1). If the parameter is not provided, the URL SHOULD be formed by appending the relative path /access/v1/evaluation to the Policy Decision Point's base URL (which is the policy_decision_point value from the PDP Metadata, if available).

The following is a non-normative example of the HTTPS binding of the Access Evaluation Request:

POST /access/v1/evaluation HTTP/1.1
Host: pdp.example.com
Content-Type: application/json
Authorization: Bearer <myoauthtoken>
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "resource": {
    "type": "todo",
    "id": "1"
  },
  "action": {
    "name": "can_read"
  },
  "context": {
    "time": "1985-10-26T01:22-07:00"
  }
}
Figure 21: Example of an HTTPS Access Evaluation Request

12.1.2. HTTPS Access Evaluation Response

The success response to an Access Evaluation Request is an Access Evaluation Response. It is an HTTPS response with a status code of 200, and content-type of application/json. Its body is a JSON object that contains the Access Evaluation Response, as defined in Section 6.2.

Following is a non-normative example of an HTTPS Access Evaluation Response:

HTTP/1.1 OK
Content-Type: application/json
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "decision": true
}
Figure 22: Example of an HTTP Access Evaluation Response

12.1.3. HTTPS Access Evaluations Request

The Access Evaluations Request is made via an HTTPS POST request. The request MUST include a Content-Type header with the value application/json. The request body MUST be a JSON object that conforms to the Access Evaluations Request structure, as defined in Section 7.1.

The request URL MUST be the value of the access_evaluations_endpoint parameter if it is provided in the PDP Metadata (Section 11.1.1). If the parameter is not provided, the URL SHOULD be formed by appending the relative path /access/v1/evaluations to the Policy Decision Point's base URL (which is the policy_decision_point value from the PDP Metadata, if available).

The following is a non-normative example of a the HTTPS binding of the Access Evaluations Request:

POST /access/v1/evaluations HTTP/1.1
Host: pdp.example.com
Content-Type: application/json
Authorization: Bearer <myoauthtoken>
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "context": {
    "time": "2024-05-31T15:22-07:00"
  },
  "action": {
    "name": "can_read"
  },
  "evaluations": [
    {
      "resource": {
        "type": "document",
        "id": "boxcarring.md"
      }
    },
    {
      "resource": {
        "type": "document",
        "id": "subject-search.md"
      }
    },
    {
      "action": {
        "name": "can_edit"
      },
      "resource": {
        "type": "document",
        "id": "resource-search.md"
      }
    }
  ]
}
Figure 23: Example of an HTTPS Access Evaluations Request

12.1.4. HTTPS Access Evaluations Response

The success response to an Access Evaluations Request is an Access Evaluations Response. It is an HTTPS response with a status code of 200, and content-type of application/json. Its body is a JSON object that contains the Access Evaluations Response, as defined in Section 7.2.

The following is a non-normative example of an HTTPS Access Evaluations Response:

HTTP/1.1 OK
Content-Type: application/json
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "evaluations": [
    {
      "decision": true
    },
    {
      "decision": false,
      "context": {
        "error": {
          "status": 404,
          "message": "Resource not found"
        }
      }
    },
    {
      "decision": false,
      "context": {
        "reason": "Subject is a viewer of the resource"
      }
    }
  ]
}
Figure 24: Example of an HTTPS Access Evaluations Response

12.1.5. HTTPS Subject Search Request

The Subject Search Request is made via an HTTPS POST request. The request MUST include a Content-Type header with the value application/json. The request body MUST be a JSON object that conforms to the Subject Search Request structure, as defined in Section 8.2.

The request URL MUST be the value of the search_subject_endpoint parameter if it is provided in the PDP Metadata (Section 11.1.1). If the parameter is not provided, the URL SHOULD be formed by appending the relative path /access/v1/search/subject to the Policy Decision Point's base URL (which is the policy_decision_point value from the PDP Metadata, if available).

The following is a non-normative example of the HTTPS binding of the Subject Search Request:

POST /access/v1/search/subject HTTP/1.1
Host: pdp.example.com
Content-Type: application/json
Authorization: Bearer <myoauthtoken>
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "subject": {
    "type": "user"
  },
  "action": {
    "name": "can_read"
  },
  "resource": {
    "type": "account",
    "id": "123"
  }
}
Figure 25: Example of an HTTPS Subject Search Request

12.1.6. HTTPS Subject Search Response

The success response to a Subject Search Request is a Subject Search Response. It is an HTTPS response with a status code of 200, and content-type of application/json. Its body is a JSON object that contains the Subject Search Response, as defined in Section 8.3.

The following is a non-normative example of an HTTPS Subject Search Response:

HTTP/1.1 OK
Content-Type: application/json
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "results": [
    {
      "type": "user",
      "id": "alice@example.com"
    },
    {
      "type": "user",
      "id": "bob@example.com"
    }
  ],
  "page": {
    "next_token": "alsehrq3495u8"
  }
}
Figure 26: Example of an HTTPS Subject Search Response

12.1.7. HTTPS Resource Search Request

The Resource Search Request is made via an HTTPS POST request. The request MUST include a Content-Type header with the value application/json. The request body MUST be a JSON object that conforms to the Resource Search Request structure, as defined in Section 9.2.

The request URL MUST be the value of the search_resource_endpoint parameter if it is provided in the PDP Metadata (Section 11.1.1). If the parameter is not provided, the URL SHOULD be formed by appending the relative path /access/v1/search/resource to the Policy Decision Point's base URL (which is the policy_decision_point value from the PDP Metadata, if available).

The following is a non-normative example of the HTTPS binding of the Resource Search Request:

POST /access/v1/search/resource HTTP/1.1
Host: pdp.example.com
Content-Type: application/json
Authorization: Bearer <myoauthtoken>
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "action": {
    "name": "can_read"
  },
  "resource": {
    "type": "account"
  }
}
Figure 27: Example of an HTTPS Resource Search Request

12.1.8. HTTPS Resource Search Response

The success response to a Resource Search Request is a Resource Search Response. It is an HTTPS response with a status code of 200, and content-type of application/json. Its body is a JSON object that contains the Resource Search Response, as defined in Section 9.3.

The following is a non-normative example of an HTTPS Resource Search Response:

HTTP/1.1 OK
Content-Type: application/json
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "results": [
    {
      "type": "account",
      "id": "123"
    },
    {
      "type": "account",
      "id": "456"
    }
  ],
  "page": {
    "next_token": "alsehrq3495u8"
  }
}
Figure 28: Example of an HTTPS Resource Search Response

12.1.9. HTTPS Action Search Request

The Action Search Request is made via an HTTPS POST request. The request MUST include a Content-Type header with the value application/json. The request body MUST be a JSON object that conforms to the Action Search Request structure, as defined in Section 10.2.

The request URL MUST be the value of the search_action_endpoint parameter if it is provided in the PDP Metadata (Section 11.1.1). If the parameter is not provided, the URL SHOULD be formed by appending the relative path /access/v1/search/action to the Policy Decision Point's base URL (which is the policy_decision_point value from the PDP Metadata, if available).

The following is a non-normative example of the HTTPS binding of the Action Search Request:

POST /access/v1/search/action HTTP/1.1
Host: pdp.example.com
Content-Type: application/json
Authorization: Bearer <myoauthtoken>
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "subject": {
    "type": "user",
    "id": "alice@example.com"
  },
  "resource": {
    "type": "account",
    "id": "123"
  },
  "context": {
    "time": "2024-10-26T01:22-07:00"
  }
}
Figure 29: Example of an HTTPS Action Search Request

12.1.10. HTTPS Action Search Response

The success response to an Action Search Request is an Action Search Response. It is an HTTPS response with a status code of 200, and content-type of application/json. Its body is a JSON object that contains the Action Search Response, as defined in Section 10.3.

The following is a non-normative example of an HTTPS Action Search Response:

HTTP/1.1 OK
Content-Type: application/json
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716

{
  "results": [
    {
      "name": "can_read"
    },
    {
      "name": "can_write"
    }
  ],
  "page": {
    "next_token": "alsehrq3495u8"
  }
}
Figure 30: Example of an HTTPS Action Search Response

12.1.11. Error Responses

The following error responses are common to all methods of the Authorization API. The error response is indicated by an HTTPS status code (Section 15 of [RFC9110]) that indicates error.

The following errors are indicated by the status codes defined below:

Table 1: HTTPS Error status codes
Code Description HTTPS Body Content
400 Bad Request An error message string
401 Unauthorized An error message string
403 Forbidden An error message string
500 Internal Error An error message string

Note: HTTPS errors are returned by the PDP to indicate an error condition relating to the request or its processing; they are unrelated to the outcome of an authorization decision and are distinct from it. A successful request that results in a "deny" is indicated by a 200 OK status code with a { "decision": false } payload.

To make this concrete:

  • a 401 HTTPS status code indicates that the caller (Policy Enforcement Point) did not properly authenticate to the PDP - for example, by omitting a required Authorization header, or using an invalid access token.

  • the PDP indicates to the caller that the authorization request is denied by sending a response with a 200 HTTPS status code, along with a payload of { "decision": false }.

12.1.12. Request Identification

All requests to the API MAY have request identifiers to uniquely identify them. The API client (PEP) is responsible for generating the request identifier. If present, it is RECOMMENDED to use the HTTPS Header X-Request-ID as the request identifier. The value of this header is an arbitrary string. The following non-normative example describes this header:

POST /access/v1/evaluation HTTP/1.1
Authorization: Bearer mF_9.B5f-4.1JqM
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716
Figure 31: Example HTTPS request with a Request Id Header

12.1.13. Request Identification in a Response

When an Authorization API request contains a request identifier the PDP MUST include a request identifier in the response. It is RECOMMENDED to specify the request identifier using the HTTPS Response header X-Request-ID. If the PEP specified a request identifier in the request, the PDP MUST include the same identifier in the response to that request.

The following is a non-normative example of an HTTPS Response with this header:

HTTP/1.1 OK
Content-Type: application/json
X-Request-ID: bfe9eb29-ab87-4ca3-be83-a1d5d8305716
Figure 32: Example HTTPS response with a Request Id Header

13. Security Considerations

13.1. Communication Integrity and Confidentiality

In the ABAC architecture, the PEP-PDP connection is the most sensitive one and needs to be secured to guarantee:

  • Integrity

  • Confidentiality

As a result, the connection between the PEP and the PDP MUST be secured using the most adequate means given the choice of transport (e.g. TLS for HTTP REST).

13.2. Policy Confidentiality and Sender Authentication

Additionally, the PDP SHOULD authenticate the calling PEP. There are several ways authentication can be established. These ways are out of scope of this specification. They MAY include:

  • Mutual TLS

  • OAuth-based authentication

  • API key

The choice and strength of either mechanism is not in scope.

Authenticating the PEP allows the PDP to avoid common attacks (such as DoS - see below) and/or reveal its internal policies. A malicious actor could craft a large number of requests to try and understand what policies the PDP is configured with. Requesting a client (PEP) be authenticated mitigates that risk.

13.3. Sender Authentication Failure

If the protected resource request does not include the proper authentication credentials, or does not have a valid authentication scheme proof that enables access to the protected resource, the resource server MUST respond with a 401 HTTP status code and SHOULD include the HTTP "WWW-Authenticate" response header field; it MAY include it in response to other conditions as well. The "WWW-Authenticate" header field uses the framework defined by HTTP/1.1 [RFC2617] and indicates the expected authentication scheme as well as the realm that has authority for it.

The following is a non-normative example response:

http HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer realm="https://as.example.com"

13.4. Trust

In ABAC, there are occasionally conversations around the trust between PEP and PDP: how can the PDP trust that the PEP is sending the correct values? The architecture of this model assumes the PDP must trust the PEP, as the PEP is ultimately responsible for enforcing the decision the PDP produces.

13.5. Authorization Response Integrity

The PDP MAY choose to sign its authorization response, ensuring the PEP can verify the integrity of the data it receives. This practice is valuable for maintaining trust in the authorization process.

The PEP can ensure that the authorization response is not tampered with by verifying the signature of the authorization decision if it is signed. It ensures response accurracy and completeness.

TLS effectively protects data in transit for a direct, point-to-point connection but does not guarantee data integrity for the full connection path between the PEP and the PDP if there are intermediaries, such as proxies or gateways.

Digital signatures offer important advantages in this context. They provide non-repudiation, allowing verification that the response genuinely originated from the PDP. Moreover, digital signatures ensure the integrity of the authorization response, confirming that its contents have not been altered in transit.

13.6. Availability & Denial of Service {#security-avail-dos}}

The PDP SHOULD apply reasonable protections to avoid common attacks tied to request payload size, the number of requests, invalid JSON, nested JSON attacks, or memory consumption. Rate limiting is one such way to address such issues.

13.7. Differences between Unsigned and Signed Metadata

Unsigned metadata is integrity protected by use of TLS at the site where it is hosted. This means that its security is dependent upon the Internet Public Key Infrastructure (PKI) [RFC9525]. Signed metadata is additionally integrity protected by the JWS signature applied by the issuer, which is not dependent upon the Internet PKI. When using unsigned metadata, the party issuing the metadata is the Policy Decision Point itself. Whereas, when using signed metadata, the party issuing the metadata is represented by the iss (issuer) claim in the signed metadata. When using signed metadata, applications can make trust decisions based on the issuer that performed the signing -- information that is not available when using unsigned metadata. How these trust decisions are made is out of scope for this specification.

13.8. Metadata Caching

Policy decision point metadata is retrieved using an HTTP GET request, as specified in Section 11.2.1. Normal HTTP caching behaviors apply, meaning that the GET may retrieve a cached copy of the content, rather than the latest copy. Implementations should utilize HTTP caching directives such as Cache-Control with max-age, as defined in [RFC7234], to enable caching of retrieved metadata for appropriate time periods.

14. IANA Considerations

The following registration procedure is used for the registry established by this specification.

Values are registered on a Specification Required [RFC8126] basis after a two-week review period on the openid-specs-authzen@lists.openid.net mailing list, on the advice of one or more Designated Experts. However, to allow for the allocation of values prior to publication of the final version of a specification, the Designated Experts may approve registration once they are satisfied that the specification will be completed and published. However, if the specification is not completed and published in a timely manner, as determined by the Designated Experts, the Designated Experts may request that IANA withdraw the registration.

Registration requests sent to the mailing list for review should use an appropriate subject (e.g., "Request to register AuthZEN Policy Decision Point Metadata: example").

Within the review period, the Designated Experts will either approve or deny the registration request, communicating this decision to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful. The IANA escalation process is followed when the Designated Experts are not responsive within 14 days.

Criteria that should be applied by the Designated Experts includes determining whether the proposed registration duplicates existing functionality, determining whether it is likely to be of general applicability or whether it is useful only for a single application, and whether the registration makes sense.

IANA must only accept registry updates from the Designated Experts and should direct all requests for registration to the review mailing list.

It is suggested that multiple Designated Experts be appointed who are able to represent the perspectives of different applications using this specification, in order to enable broadly-informed review of registration decisions. In cases where a registration decision could be perceived as creating a conflict of interest for a particular Expert, that Expert should defer to the judgment of the other Experts.

The reason for the use of the mailing list is to enable public review of registration requests, enabling both Designated Experts and other interested parties to provide feedback on proposed registrations. The reason to allow the Designated Experts to allocate values prior to publication as a final specification is to enable giving authors of specifications proposing registrations the benefit of review by the Designated Experts before the specification is completely done, so that if problems are identified, the authors can iterate and fix them before publication of the final specification.

14.1. AuthZEN Policy Decision Point Metadata Registry

This specification establishes the IANA "AuthZEN Policy Decision Point Metadata" registry for AuthZEN Policy Decision Point metadata names. The registry records the Policy Decision Point metadata parameter and a reference to the specification that defines it.

14.1.1. Registration Template

Metadata Name:

The name requested (e.g., "resource"). This name is case-sensitive. Names may not match other registered names in a case-insensitive manner unless the Designated Experts state that there is a compelling reason to allow an exception.

Metadata Description:

Brief description of the metadata (e.g., "Resource identifier URL").

Change Controller:

For IETF stream RFCs, list the "IETF". For others, give the name of the responsible party. Other details (e.g., postal address, email address, home page URI) may also be included.

Specification Document(s):

Reference to the document or documents that specify the parameter, preferably including URIs that can be used to retrieve copies of the documents. An indication of the relevant sections may also be included but is not required.

14.1.2. Initial Registry Contents

Metadata name:

policy_decision_point

Metadata description:

Base URL of the Policy Decision Point

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

access_evaluation_endpoint

Metadata description:

URL of Policy Decision Point Access Evaluation API endpoint

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

access_evaluations_endpoint

Metadata description:

URL of Policy Decision Point Access Evaluations API endpoint

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

search_subject_endpoint

Metadata description:

URL of the Search Endpoint based on Subject element

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

search_resource_endpoint

Metadata description:

URL of the Search Endpoint based on Resource element

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

search_action_endpoint

Metadata description:

URL of the Search Endpoint based on Action element

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

capabilities

Metadata description:

Array of URNs describing specific PDP capabilities

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

Metadata name:

signed_metadata

Metadata description:

JWT containing metadata parameters about the protected resource as claims.

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Specification Document(s):

Section Section 11.1.1

14.2. Well-Known URI Registry

This specification registers the well-known URI defined in Section 3 in the IANA "Well-Known URIs" registry [IANA.well-known-uris].

14.2.1. Registry Contents

URI Suffix:

authzen-configuration

Reference:

Section Section 11.1.1

Status:

permanent

Change Controller:

OpenID_Foundation_AuthZEN_Working_Group

mailto:openid-specs-authzen@lists.openid.net

Related Information:

(none)

14.3. AuthZEN PDP capabilities Registry

This specification establishes the IANA "AuthZEN Policy Decision Point Capabilities" registry for AuthZEN Policy Decision Point specific capabilities or features. The content of this registry will be specified by AuthZEN compliance PDP vendors that want to declare interoperable capabilities.

15. References

15.1. Normative References

[RFC6749]
Hardt, D., Ed., "The OAuth 2.0 Authorization Framework", RFC 6749, DOI 10.17487/RFC6749, , <https://www.rfc-editor.org/rfc/rfc6749>.
[RFC8259]
Bray, T., Ed., "The JavaScript Object Notation (JSON) Data Interchange Format", STD 90, RFC 8259, DOI 10.17487/RFC8259, , <https://www.rfc-editor.org/rfc/rfc8259>.
[RFC8615]
Nottingham, M., "Well-Known Uniform Resource Identifiers (URIs)", RFC 8615, DOI 10.17487/RFC8615, , <https://www.rfc-editor.org/rfc/rfc8615>.
[RFC9110]
Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke, Ed., "HTTP Semantics", STD 97, RFC 9110, DOI 10.17487/RFC9110, , <https://www.rfc-editor.org/rfc/rfc9110>.
[XACML]
Godik, S., Ed. and T. M. (Ed.), Ed., "eXtensible Access Control Markup Language (XACML) Version 1.1", , <https://www.oasis-open.org/committees/xacml/repository/cs-xacml-specification-1.1.pdf>.

15.2. Informative References

[RFC7519]
Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token (JWT)", RFC 7519, DOI 10.17487/RFC7519, , <https://www.rfc-editor.org/rfc/rfc7519>.
[RFC7515]
Jones, M., Bradley, J., and N. Sakimura, "JSON Web Signature (JWS)", RFC 7515, DOI 10.17487/RFC7515, , <https://www.rfc-editor.org/rfc/rfc7515>.
[RFC8126]
Cotton, M., Leiba, B., and T. Narten, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 8126, DOI 10.17487/RFC8126, , <https://www.rfc-editor.org/rfc/rfc8126>.
[IANA.well-known-uris]
IANA, "Well-Known URIs", <https://www.iana.org/assignments/well-known-uris>.
[RFC9525]
Saint-Andre, P. and R. Salz, "Service Identity in TLS", RFC 9525, DOI 10.17487/RFC9525, , <https://www.rfc-editor.org/rfc/rfc9525>.
[RFC7234]
Fielding, R., Ed., Nottingham, M., Ed., and J. Reschke, Ed., "Hypertext Transfer Protocol (HTTP/1.1): Caching", RFC 7234, DOI 10.17487/RFC7234, , <https://www.rfc-editor.org/rfc/rfc7234>.
[RFC2617]
Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S., Leach, P., Luotonen, A., and L. Stewart, "HTTP Authentication: Basic and Digest Access Authentication", RFC 2617, DOI 10.17487/RFC2617, , <https://www.rfc-editor.org/rfc/rfc2617>.
[NIST.SP.800-162]
Hu, V. C., Ferraiolo, D., Kuhn, R., Schnitzer, A., Sandlin, K., Miller, R., Scarfone, K., and NIST, "Guide to Attribute Based Access Control (ABAC) Definition and Considerations", NIST Special Publications (General) 800-162, DOI 10.6028/NIST.SP.800-162, , <https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-162.pdf>.

Appendix A. Terminology

Subject:

The user or machine principal for whom an authorization decision is being requested.

Resource:

The target of the request; the resource about which the Authorization API is being made.

Action:

The operation the Subject has attempted on the Resource in an Authorization API call.

Context:

The environmental or contextual attributes for this request.

Decision:

The value of the evaluation decision made by the PDP: true for "allow", false for "deny".

PDP:

Policy Decision Point. The component or system that provides authorization decisions over the network interface defined here as the Authorization API.

PEP:

Policy Enforcement Point. The component or system that requests decisions from the PDP and enforces access to specific requests based on the decisions obtained from the PDP.

Appendix B. Acknowledgements

This template uses extracts from templates written by Pekka Savola, Elwyn Davies and Henrik Levkowetz.

Appendix C. Document History

** To be removed from the final specification **

Appendix D. Notices

Copyright (c) 2025 The OpenID Foundation.

The OpenID Foundation (OIDF) grants to any Contributor, developer, implementer, or other interested party a non-exclusive, royalty free, worldwide copyright license to reproduce, prepare derivative works from, distribute, perform and display, this Implementers Draft, Final Specification, or Final Specification Incorporating Errata Corrections solely for the purposes of (i) developing specifications, and (ii) implementing Implementers Drafts, Final Specifications, and Final Specification Incorporating Errata Corrections based on such documents, provided that attribution be made to the OIDF as the source of the material, but that such attribution does not indicate an endorsement by the OIDF.

The technology described in this specification was made available from contributions from various sources, including members of the OpenID Foundation and others. Although the OpenID Foundation has taken steps to help ensure that the technology is available for distribution, it takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this specification or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any independent effort to identify any such rights. The OpenID Foundation and the contributors to this specification make no (and hereby expressly disclaim any) warranties (express, implied, or otherwise), including implied warranties of merchantability, non-infringement, fitness for a particular purpose, or title, related to this specification, and the entire risk as to implementing this specification is assumed by the implementer. The OpenID Intellectual Property Rights policy (found at openid.net) requires contributors to offer a patent promise not to assert certain patent claims against other contributors and against implementers. OpenID invites any interested party to bring to its attention any copyrights, patents, patent applications, or other proprietary rights that may cover technology that may be required to practice this specification.

Contributors

Marc Jordan
SGNL
Erik Gustavson
SGNL
Alexandre Babeanu
Indykite
David Hyland
ID Partners
Jean-François Lombardo
AWS
Alex Olivier
Cerbos

Authors' Addresses

Omri Gazitt (editor)
Aserto
David Brossard (editor)
Axiomatics
Atul Tulshibagwale (editor)
SGNL