Access

Check Permissions

Changed on

Evaluate a permission against the AUTHENTICATED scope.

scope_id asserts that the request was authenticated for that scope; it never selects it. A caller asking about a specific project must also send the project_id query param the auth middleware reads — a session with no explicit project_id is scoped to the default project, and any other scope_id is denied regardless of the caller's role there.

get/access/permissions/check

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/access/permissions/check
  • Auth
    API key in header Authorization

Query parameters

actionstring nullable
scope_typestring nullable
scope_idstring uuid nullable
resource_typestring nullable
resource_idstring uuid nullable
without_grantsboolean

Response

Successful Response

unknown required

Changes