Hanzo
OpenapiO11y

Evaluates a batch of transactions — relation plus object — for the…

Evaluates a batch of transactions — relation plus object — for the authenticated caller and answers each with its authorization verdict, in the order they…

POST /v1/o11y/authz/check

Addresshttps://api.hanzo.ai/v1/o11y/authz/check
MethodPOST
OperationAuthzCheck
AuthAuthorization: Bearer $HANZO_API_KEY

Evaluates a batch of transactions — relation plus object — for the authenticated caller and answers each with its authorization verdict, in the order they were asked. It is the read a UI uses to decide which controls to show.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
[].objectbodyo11y.O11yObject
[].object.resourcebodyo11y.O11yResourceRef
[].object.resource.kindbodystringKind is the resource kind the type belongs to.
[].object.resource.typebodystringType is the resource type, e.g.
[].object.selectorbodystringSelector picks the instance — an FGA object string, wildcard allowed.
[].relationbodystringRelation is the verb being asked about, e.g.

Response

StatusBodyMeaning
200o11y.O11yCheckOutok

200 body — 9 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yTransactionResult[]Data holds the verdicts.
data[].authorizedbodybooleanAuthorized says whether the caller may do it.
data[].objectbodyo11y.O11yObject
data[].object.resourcebodyo11y.O11yResourceRef
data[].object.resource.kindbodystringKind is the resource kind the type belongs to.
data[].object.resource.typebodystringType is the resource type, e.g.
data[].object.selectorbodystringSelector picks the instance — an FGA object string, wildcard allowed.
data[].relationbodystringRelation is the verb that was asked about.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y authz check

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page