Hanzo
OpenapiIam

Makes a role — a named group of people that permissions are granted to.

Makes a role — a named group of people that permissions are granted to.

POST /v1/iam/roles

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

Makes a role — a named group of people that permissions are granted to. Granting to a role rather than to each person is what keeps access correct as your team changes: add someone to the role and they inherit everything it can do. A name already used in your organization is refused.

Request

10 fields, body application/json (required).

FieldInTypeRequiredDescription
createdTimebodystring
descriptionbodystring
displayNamebodystring
domainsbodystring[]
groupsbodystring[]
isEnabledbodyboolean
namebodystring
ownerbodystring
rolesbodystring[]
usersbodystring[]

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 create

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page