OpenapiFramework
Grants one user one role in the caller's org — how a member gains rights on a…
Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name roles and never users. Manager-only.
POST /v1/framework/roles
| Address | https://api.hanzo.ai/v1/framework/roles |
| Method | POST |
| Operation | post_framework_roles |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Grants one user one role in the caller's org — how a member gains rights on a DocType, since permissions name roles and never users. Manager-only. Answers 201.
Request
2 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
role | body | string | — | Role is the granted role's name. |
user | body | string | — | User is the member the role is granted to. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | RoleAssignment | created |
201 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
role | body | string | — | Role is the granted role's name. |
user | body | string | — | User is the member the role is granted to. |
Failure carries the platform error shape — see Errors.
Examples
hanzo framework roles createimport { Configuration, FrameworkApi } from 'hanzoai';
const api = new FrameworkApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postFrameworkRoles({ role: "<role>", user: "<user>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import FrameworkApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = FrameworkApi(client).post_framework_roles(role="<role>", user="<user>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.FrameworkAPI.PostFrameworkRoles(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, framework_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = framework_api::post_framework_roles(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.FrameworkApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new FrameworkApi(client).postFrameworkRoles();curl -X POST https://api.hanzo.ai/v1/framework/roles \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"role": "<role>",
"user": "<user>"
}'The door reaches framework through the framework tool, which names its 17 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
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": "get_framework_by_doctype"
}
}
}'How is this guide?