Hanzo
OpenapiIam

Returns one role: who is in it, and the roles it includes.

Returns one role: who is in it, and the roles it includes.

POST /v1/iam/roles/get

Addresshttps://api.hanzo.ai/v1/iam/roles/get
MethodPOST
Operationpost_iam_roles_get
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one role: who is in it, and the roles it includes.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
namebodystring
ownerbodystring

Response

StatusBodyMeaning
200iam.Roleok

200 body — 14 fields.

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

Failure carries the platform error shape — see Errors.

Examples

hanzo iam roles get

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page