Get roles

Returns one role with the transaction groups it grants.

GET /v1/o11y/roles/{id}

O11y → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/o11y/roles/{id}`
Method	`GET`
Operation	`GetRole`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one role with the transaction groups it grants.

Request

1 field.

Field	In	Type	Required	Description
`id`	path	string	yes

Response

Status	Body	Meaning
`200`	o11y.O11yRoleOut	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 16 fields.

Field	In	Type	Always	Description
`data`	body	o11y.O11yRoleDetail	—
`data.createdAt`	body	string (date-time)	—	CreatedAt is when the role was created.
`data.description`	body	string	—	Description says what the role is for.
`data.id`	body	string	—	ID is the role id.
`data.name`	body	string	—	Name is the role's name.
`data.orgId`	body	string	—	OrgID is the org the role belongs to.
`data.transactionGroups`	body	o11y.O11yTransactionGroup[]	—	TransactionGroups are the grants the role carries.
`data.transactionGroups[].objectGroup`	body	o11y.O11yObjectGroup	—
`data.transactionGroups[].objectGroup.resource`	body	o11y.O11yResourceRef	—
`data.transactionGroups[].objectGroup.resource.kind`	body	string	—	Kind is the resource kind the type belongs to.
`data.transactionGroups[].objectGroup.resource.type`	body	string	—	Type is the resource type, e.g. role, dashboard, serviceaccount.
`data.transactionGroups[].objectGroup.selectors`	body	string[]	—	Selectors pick the instances; a wildcard selects them all.
`data.transactionGroups[].relation`	body	string	—	Relation is the verb the grant allows.
`data.type`	body	string	—	Type is custom or managed.
`data.updatedAt`	body	string (date-time)	—	UpdatedAt is when it last changed.
`status`	body	string	—	Status is "success".

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo o11y roles get <id>

.ts

.py

.go

.rs

.java

import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getRole({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).get_role(id='id')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.GetRole(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::get_role(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).getRole();

curl https://api.hanzo.ai/v1/o11y/roles/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool o11y, op GetRole — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "o11y",
         "arguments": {
           "op": "GetRole",
           "input": {
             "id": "<id>"
           }
         }
       }
     }'

O11y API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList filters NextGet route policies