Returns one workspace: what it is called and how it is set up.
Returns one workspace: what it is called and how it is set up.
GET /v1/iam/workspaces/{owner}/{name}
| Address | https://api.hanzo.ai/v1/iam/workspaces/{owner}/{name} |
| Method | GET |
| Operation | get_iam_workspaces_by_owner_by_name |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one workspace: what it is called and how it is set up.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
owner | path | string | yes | |
name | path | string | yes |
Response
| Status | Body | Meaning |
|---|---|---|
200 | iam.Workspace | ok |
200 body — 14 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
bucket | body | string | — | |
createdAt | body | string (date-time) | — | |
createdTime | body | string | — | |
deleted | body | boolean | — | |
description | body | string | — | |
displayName | body | string | — | |
id | body | string | — | |
isDefault | body | boolean | — | |
metadata | body | string | — | |
name | body | string | — | |
organization | body | string | — | |
owner | body | string | — | |
tags | body | string[] | — | |
updatedAt | body | string (date-time) | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.
import { Configuration, IamApi } from 'hanzoai';
const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getIamWorkspacesByOwnerByName({ owner: 'owner', name: 'name' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IamApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IamApi(client).get_iam_workspaces_by_owner_by_name(owner='owner', name='name')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IamAPI.GetIamWorkspacesByOwnerByName(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, iam_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = iam_api::get_iam_workspaces_by_owner_by_name(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IamApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new IamApi(client).getIamWorkspacesByOwnerByName();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/iam/workspaces/<owner>/<name> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches iam through the iam tool, which names its 75 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": "list__well_known_jwks"
}
}
}'How is this guide?