Hanzo
OpenapiIam

Returns your organization's roles, newest first — each a named group of people…

Returns your organization's roles, newest first — each a named group of people that permissions are granted to.

GET /v1/iam/roles

Addresshttps://api.hanzo.ai/v1/iam/roles
MethodGET
Operationget_iam_roles
AuthAuthorization: Bearer $HANZO_API_KEY

Returns your organization's roles, newest first — each a named group of people that permissions are granted to.

You see your own organization's roles and no one else's; which organization that is comes from your credentials, not from the request.

Request

1 field.

FieldInTypeRequiredDescription
ownerquerystring

Response

StatusBodyMeaning
200iam.roles.ListOutputok

200 body — 16 fields.

FieldInTypeAlwaysDescription
rolesbodyiam.Role[]
roles[].createdAtbodystring (date-time)
roles[].createdTimebodystring
roles[].deletedbodyboolean
roles[].descriptionbodystring
roles[].displayNamebodystring
roles[].domainsbodystring[]
roles[].groupsbodystring[]
roles[].idbodystring
roles[].isEnabledbodyboolean
roles[].namebodystring
roles[].ownerbodystring
roles[].rolesbodystring[]
roles[].updatedAtbodystring (date-time)
roles[].usersbodystring[]
totalbodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page