Hanzo
OpenapiFramework

Returns every (user, role) assignment in the caller's org.

Returns every (user, role) assignment in the caller's org.

GET /v1/framework/roles

Addresshttps://api.hanzo.ai/v1/framework/roles
MethodGET
Operationget_framework_roles
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every (user, role) assignment in the caller's org. Roles are what DocType permissions are written against, so this is the grant table the permission calculus resolves a member's rights from.

Request

GET /v1/framework/roles takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200roleListok

200 body — 3 fields.

FieldInTypeAlwaysDescription
databodyRoleAssignment[]Data is every (user, role) assignment in the caller's org.
data[].rolebodystringRole is the granted role's name.
data[].userbodystringUser is the member the role is granted to.

Failure carries the platform error shape — see Errors.

Examples

hanzo framework roles list

Framework API · All Hanzo APIs · Interactive reference

How is this guide?

On this page