Hanzo
OpenapiO11y

Returns one role with the transaction groups it grants.

Returns one role with the transaction groups it grants.

GET /v1/o11y/roles/{id}

Addresshttps://api.hanzo.ai/v1/o11y/roles/{id}
MethodGET
OperationGetRole
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one role with the transaction groups it grants.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyes

Response

StatusBodyMeaning
200o11y.O11yRoleOutok

200 body — 16 fields.

FieldInTypeAlwaysDescription
databodyo11y.O11yRoleDetail
data.createdAtbodystring (date-time)CreatedAt is when the role was created.
data.descriptionbodystringDescription says what the role is for.
data.idbodystringID is the role id.
data.namebodystringName is the role's name.
data.orgIdbodystringOrgID is the org the role belongs to.
data.transactionGroupsbodyo11y.O11yTransactionGroup[]TransactionGroups are the grants the role carries.
data.transactionGroups[].objectGroupbodyo11y.O11yObjectGroup
data.transactionGroups[].objectGroup.resourcebodyo11y.O11yResourceRef
data.transactionGroups[].objectGroup.resource.kindbodystringKind is the resource kind the type belongs to.
data.transactionGroups[].objectGroup.resource.typebodystringType is the resource type, e.g.
data.transactionGroups[].objectGroup.selectorsbodystring[]Selectors pick the instances; a wildcard selects them all.
data.transactionGroups[].relationbodystringRelation is the verb the grant allows.
data.typebodystringType is custom or managed.
data.updatedAtbodystring (date-time)UpdatedAt is when it last changed.
statusbodystringStatus is "success".

Failure carries the platform error shape — see Errors.

Examples

hanzo o11y roles get <id>

O11y API · All Hanzo APIs · Interactive reference

How is this guide?

On this page