Access

Check whether a principal may perform an action

Changed on

Evaluates one action for a member or key of the organization and returns the decision, the layer that decided it and the deciding policies.

Requires the policy.read permission. See Permissions for the roles and API key permissions that include it.

post/v1/authz/check

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/authz/check
  • Auth
    HTTP bearer

Request body

actionstring required

An action from the catalog, e.g. compute.create.

endpointIdstring

The dedicated endpoint the model is served on.

modelstring

The model to check for inference.invoke.

principalIdstring required

A user id or API key id of this organization.

principalType'member' | 'api_key' required
sourceIpstring

Evaluate as if the request came from this address. Defaults to yours.

Response

The decision

allowboolean required
deniedBy'role' | 'key' | 'org_policy' | 'platform'
messagestring required
permissionstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 551a288b9aa0Revision changes
    • breaking

      removed the enum value service_account of the request property