Hanzo AI
OpenapiIam

Create profile

Changes how an organization reads: its display name, its website and its favicon.

POST /v1/iam/organizations/profile

Addresshttps://api.hanzo.ai/v1/iam/organizations/profile
MethodPOST
OperationsetOrganizationProfile
AuthAuthorization: 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).

FieldInTypeRequiredDescription
displayNamebodystring
faviconbodystring
namebodystring
ownerbodystring
websiteUrlbodystring

Response

StatusBodyMeaning
200iam.Organizationok
202Approvalheld for approval
defaultproblem-detailsrefused

200 body — 74 fields.

FieldInTypeAlwaysDescription
accountItemsbodyiam.AccountItem[]
accountItems[].modifyRulebodystring
accountItems[].namebodystring
accountItems[].regexbodystring
accountItems[].tabbodystring
accountItems[].viewRulebodystring
accountItems[].visiblebodyboolean
accountMenubodystring
avatarbodystringHow the organization appears across Hanzo — the square mark beside its name — as an image or as one emoji, never both.
balanceCreditbodynumber (double)
balanceCurrencybodystring
countryCodesbodystring[]
createdAtbodystring (date-time)
createdTimebodystring
dcrPolicybodystring
defaultApplicationbodystring
defaultAvatarbodystring
defaultPasswordbodystring
deletedbodyboolean
disableSigninbodyboolean
displayNamebodystring
emojibodystring
enableSoftDeletionbodyboolean
enableTourbodyboolean
failedSigninFrozenTimebodyinteger (int64)
failedSigninLimitbodyinteger (int64)Per-organization signin throttle. Zero means "inherit the application default"; a non-zero value overrides it.
faviconbodystring
founderbodystringFounder is the stable storage id of the identity that provisioned this org (self-service onboarding).
hasPrivilegeConsentbodyboolean
idbodystring
initScorebodyinteger (int64)
ipRestrictionbodystring
ipWhitelistbodystring
isPersonalbodyboolean
isProfilePublicbodyboolean
kerberosKdcHostbodystring
kerberosKeytabbodystring
kerberosRealmbodystring
kerberosServiceNamebodystring
languagesbodystring[]
ldapAttributesbodystring[]
logobodystring
logoDarkbodystring
masterPasswordbodystring
masterVerificationCodebodystring
mfaItemsbodyiam.MfaItem[]
mfaItems[].namebodystring
mfaItems[].rulebodystring
mfaRememberInHoursbodyinteger (int64)
namebodystring
navItemsbodystring[]
orgBalancebodynumber (double)Balance fields are read-only mirrors; authoritative balances live in Commerce (billing.hanzo.ai).
ownerbodystring
passwordExpireDaysbodyinteger (int64)
passwordObfuscatorKeybodystring
passwordObfuscatorTypebodystring
passwordOptionsbodystring[]
passwordSaltbodystring
passwordTypebodystring
tagsbodystring[]
themeDatabodyiam.ThemeData
themeData.borderRadiusbodyinteger (int64)
themeData.colorPrimarybodystring
themeData.isCompactbodyboolean
themeData.isEnabledbodyboolean
themeData.themeTypebodystring
updatedAtbodystring (date-time)
useEmailAsUsernamebodyboolean
usePermanentAvatarbodyboolean
userBalancebodynumber (double)
userNavItemsbodystring[]
userTypesbodystring[]
websiteUrlbodystring
widgetItemsbodystring[]

Failure carries the platform error shape — see Errors.

Examples

hanzo iam organizations profile

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page