permission

Check a permission

Changed on

To learn how relationship tuples and the check works, head over to the documentation.

post/relation-tuples/check

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /relation-tuples/check
  • Auth
    none declared

Query parameters

max-depthinteger

Request body

namespacestring

Namespace to query

objectstring

Object to query

relationstring

Relation to query

subject_idstring

SubjectID to query

Either SubjectSet or SubjectID can be provided.

Response

checkPermissionResult

allowedboolean required

whether the relation tuple is allowed

Changes

    • info

      api operation id postCheckMirrorStatus removed and replaced with postCheckPermissionOrError

    • info

      api tag permission added

    • info

      api tag read removed

    • info

      added the new optional query request parameter max-depth

    • info

      removed the non-success response with the status

    • warning

      deleted the query request parameter max-depth

    • info

      api operation id postCheck removed and replaced with postCheckMirrorStatus