Skip to main content

Authorize User Access

Assuming object types, users and warrants are defined for your system, you can add runtime checks to your application to authorize user access.

For example, you may want to check if the user identified by userId 5djfs6 can view the report with id avk2837. A warrant check for this condition will return a 200 OK if the request is successful. The response body will contain "result": "Authorized" if the user has access or "result": "Not Authorized" if the user does not have access.

POST /v2/authorize


opThe logical operator to use when warrants contains more than one warrant. Valid values are allOf and anyOf. allOf will return “Authorized” only if all warrants are found, and anyOf will return “Authorized” if at least one of the warrants is found.JSON bodyno
warrantsArray of warrants that you want to check. Each warrant should be formatted as below in the Warrant Parameters table.JSON bodyyes

Warrant Parameters

objectTypeThe type of object. Must be one of your system's existing object types.JSON bodyyes
objectIdThe id of the specific object.JSON bodyyes
relationThe relation to check for this object to subject association. The relation must be valid as per the object type definition.JSON bodyyes
subjectThe specific subject for which access will be checked. Can be a specific object by id or an objectType, objectId and relation set.JSON bodyyes


curl "" \
-H "Authorization: ApiKey YOUR_KEY" \
--data-raw \
"warrants": [
"objectType": "report",
"objectId": "avk2837",
"relation": "viewer",
"subject": {
"objectType": "user",
"objectId": "5djfs6"


200 OK

"code": 200,
"result": "Authorized"