Create profile
Changes how an organization reads: its display name, its website and its favicon.
POST /v1/iam/organizations/profile
| Address | https://api.hanzo.ai/v1/iam/organizations/profile |
| Method | POST |
| Operation | setOrganizationProfile |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Changes how an organization reads: its display name, its website and its favicon.
IT EXISTS FOR THE REASON SetAvatar DOES, and the reason is worth stating because the obvious alternative is a trap. Update REPLACES the whole record, so a caller that wants to change one field has to send every other field back — and a record read back first arrives MASKED, so the read half of that read-modify-write hands you "***" for the master password and the salt, and the write half stores it. Renaming an organization through Update therefore costs it its credential settings; sending only the new name costs it everything else. Neither is a rename.
So this writes the fields it names and touches nothing else. A nil pointer is not sent and not changed; an empty string is sent and clears the field.
Request
5 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
displayName | body | string | — | |
favicon | body | string | — | |
name | body | string | — | |
owner | body | string | — | |
websiteUrl | body | string | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | iam.Organization | ok |
202 | Approval | held for approval |
default | problem-details | refused |
200 body — 74 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
accountItems | body | iam.AccountItem[] | — | |
accountItems[].modifyRule | body | string | — | |
accountItems[].name | body | string | — | |
accountItems[].regex | body | string | — | |
accountItems[].tab | body | string | — | |
accountItems[].viewRule | body | string | — | |
accountItems[].visible | body | boolean | — | |
accountMenu | body | string | — | |
avatar | body | string | — | How the organization appears across Hanzo — the square mark beside its name — as an image or as one emoji, never both. |
balanceCredit | body | number (double) | — | |
balanceCurrency | body | string | — | |
countryCodes | body | string[] | — | |
createdAt | body | string (date-time) | — | |
createdTime | body | string | — | |
dcrPolicy | body | string | — | |
defaultApplication | body | string | — | |
defaultAvatar | body | string | — | |
defaultPassword | body | string | — | |
deleted | body | boolean | — | |
disableSignin | body | boolean | — | |
displayName | body | string | — | |
emoji | body | string | — | |
enableSoftDeletion | body | boolean | — | |
enableTour | body | boolean | — | |
failedSigninFrozenTime | body | integer (int64) | — | |
failedSigninLimit | body | integer (int64) | — | Per-organization signin throttle. Zero means "inherit the application default"; a non-zero value overrides it. |
favicon | body | string | — | |
founder | body | string | — | Founder is the stable storage id of the identity that provisioned this org (self-service onboarding). |
hasPrivilegeConsent | body | boolean | — | |
id | body | string | — | |
initScore | body | integer (int64) | — | |
ipRestriction | body | string | — | |
ipWhitelist | body | string | — | |
isPersonal | body | boolean | — | |
isProfilePublic | body | boolean | — | |
kerberosKdcHost | body | string | — | |
kerberosKeytab | body | string | — | |
kerberosRealm | body | string | — | |
kerberosServiceName | body | string | — | |
languages | body | string[] | — | |
ldapAttributes | body | string[] | — | |
logo | body | string | — | |
logoDark | body | string | — | |
masterPassword | body | string | — | |
masterVerificationCode | body | string | — | |
mfaItems | body | iam.MfaItem[] | — | |
mfaItems[].name | body | string | — | |
mfaItems[].rule | body | string | — | |
mfaRememberInHours | body | integer (int64) | — | |
name | body | string | — | |
navItems | body | string[] | — | |
orgBalance | body | number (double) | — | Balance fields are read-only mirrors; authoritative balances live in Commerce (billing.hanzo.ai). |
owner | body | string | — | |
passwordExpireDays | body | integer (int64) | — | |
passwordObfuscatorKey | body | string | — | |
passwordObfuscatorType | body | string | — | |
passwordOptions | body | string[] | — | |
passwordSalt | body | string | — | |
passwordType | body | string | — | |
tags | body | string[] | — | |
themeData | body | iam.ThemeData | — | |
themeData.borderRadius | body | integer (int64) | — | |
themeData.colorPrimary | body | string | — | |
themeData.isCompact | body | boolean | — | |
themeData.isEnabled | body | boolean | — | |
themeData.themeType | body | string | — | |
updatedAt | body | string (date-time) | — | |
useEmailAsUsername | body | boolean | — | |
usePermanentAvatar | body | boolean | — | |
userBalance | body | number (double) | — | |
userNavItems | body | string[] | — | |
userTypes | body | string[] | — | |
websiteUrl | body | string | — | |
widgetItems | body | string[] | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo iam organizations profileimport { Configuration, IamApi } from 'hanzoai';
const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.setOrganizationProfile({ displayName: "<displayName>", favicon: "<favicon>" });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).set_organization_profile(display_name="<displayName>", favicon="<favicon>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.IamAPI.SetOrganizationProfile(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::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::set_organization_profile(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IamApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new IamApi(client).setOrganizationProfile();curl -X POST https://api.hanzo.ai/v1/iam/organizations/profile \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"displayName": "<displayName>",
"favicon": "<favicon>"
}'MCP reaches iam through the iam tool, which names its 75 operations with its own verbs — this one among them, under a name only MCP 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?