# Replace roles

URL: https://docs.hanzo.ai/docs/openapi/o11y/updaterole

> Replaces a custom role's description and transaction groups.

`PUT /v1/o11y/roles/{id}`

> [O11y →](https://docs.hanzo.ai/docs/openapi/o11y) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                           |
| ------------- | ----------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/o11y/roles/{id}` |
| **Method**    | `PUT`                                     |
| **Operation** | `UpdateRole`                              |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`    |

Replaces a custom role's description and transaction groups.
Both fields are mandatory — send an empty string or an empty array to clear
one — and managed roles cannot be edited.

## Request

9 fields, body `application/json` (required).

| Field                                           | In   | Type                         | Required | Description                                                      |
| ----------------------------------------------- | ---- | ---------------------------- | -------- | ---------------------------------------------------------------- |
| `id`                                            | path | string                       | yes      |                                                                  |
| `description`                                   | body | string                       | —        | Description says what the role is for.                           |
| `transactionGroups`                             | body | o11y.O11yTransactionGroup\[] | —        | TransactionGroups are the grants the role carries.               |
| `transactionGroups[].objectGroup`               | body | o11y.O11yObjectGroup         | —        |                                                                  |
| `transactionGroups[].objectGroup.resource`      | body | o11y.O11yResourceRef         | —        |                                                                  |
| `transactionGroups[].objectGroup.resource.kind` | body | string                       | —        | Kind is the resource kind the type belongs to.                   |
| `transactionGroups[].objectGroup.resource.type` | body | string                       | —        | Type is the resource type, e.g. role, dashboard, serviceaccount. |
| `transactionGroups[].objectGroup.selectors`     | body | string\[]                    | —        | Selectors pick the instances; a wildcard selects them all.       |
| `transactionGroups[].relation`                  | body | string                       | —        | Relation is the verb the grant allows.                           |

## Response

| Status    | Body            | Meaning           |
| --------- | --------------- | ----------------- |
| `202`     | Approval        | held for approval |
| `204`     | —               | no content        |
| `default` | problem-details | refused           |

`202` body — 3 fields.

| Field    | In   | Type   | Always | Description |
| -------- | ---- | ------ | ------ | ----------- |
| `clause` | body | string | —      |             |
| `reason` | body | string | —      |             |
| `status` | body | string | —      |             |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo o11y roles set <id>
```

**SDK**

**.ts**

```ts
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.updateRole({ id: 'id', description: "<description>", transactionGroups: [{"objectGroup":{"resource":{"kind":null,"type":null},"selectors":[null]},"relation":"<relation>"}] });
```

**.py**

```python
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).update_role(id='id', description="<description>", transaction_groups=[{"objectGroup":{"resource":{"kind":null,"type":null},"selectors":[null]},"relation":"<relation>"}])
```

**.go**

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

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

**.rs**

```rust
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::update_role(&cfg, Default::default()).await?;
```

**.java**

```java
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).updateRole();
```

**HTTP**

```bash
curl -X PUT https://api.hanzo.ai/v1/o11y/roles/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "description": "<description>",
       "transactionGroups": [
         {
           "objectGroup": {
             "resource": {
               "kind": null,
               "type": null
             },
             "selectors": [
               null
             ]
           },
           "relation": "<relation>"
         }
       ]
     }'
```

**MCP**

MCP reaches **o11y** through the `o11y` tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'
```

---

[O11y API](https://docs.hanzo.ai/docs/openapi/o11y) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)