Hanzo
OpenapiIam

Returns one organization: its display, its defaults and the sign-in rules…

Returns one organization: its display, its defaults and the sign-in rules everyone in it inherits.

GET /v1/iam/organizations/get

Addresshttps://api.hanzo.ai/v1/iam/organizations/get
MethodGET
OperationgetOrganization
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one organization: its display, its defaults and the sign-in rules everyone in it inherits.

Request

2 fields.

FieldInTypeRequiredDescription
ownerquerystring
namequerystring

Response

StatusBodyMeaning
200iam.Organizationok

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
balanceCurrencybodystring
countryCodesbodystring[]
createdAtbodystring (date-time)
createdTimebodystring
dcrPolicybodystring
defaultApplicationbodystring
defaultAvatarbodystring
defaultPasswordbodystring
deletedbodyboolean
disableSigninbodyboolean
displayNamebodystring
emojibodystring
enableSoftDeletionbodyboolean
enableTourbodyboolean
failedSigninFrozenTimebodyinteger
failedSigninLimitbodyintegerPer-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
ipRestrictionbodystring
ipWhitelistbodystring
isPersonalbodyboolean
isProfilePublicbodyboolean
kerberosKdcHostbodystring
kerberosKeytabbodystring
kerberosRealmbodystring
kerberosServiceNamebodystring
languagesbodystring[]
ldapAttributesbodystring[]
logobodystring
logoDarkbodystring
masterPasswordbodystring
masterVerificationCodebodystring
mfaItemsbodyiam.MfaItem[]
mfaItems[].namebodystring
mfaItems[].rulebodystring
mfaRememberInHoursbodyinteger
namebodystring
navItemsbodystring[]
orgBalancebodynumberBalance fields are read-only mirrors; authoritative balances live in Commerce (billing.hanzo.ai).
ownerbodystring
passwordExpireDaysbodyinteger
passwordObfuscatorKeybodystring
passwordObfuscatorTypebodystring
passwordOptionsbodystring[]
passwordSaltbodystring
passwordTypebodystring
tagsbodystring[]
themeDatabodyiam.ThemeData
themeData.borderRadiusbodyinteger
themeData.colorPrimarybodystring
themeData.isCompactbodyboolean
themeData.isEnabledbodyboolean
themeData.themeTypebodystring
updatedAtbodystring (date-time)
useEmailAsUsernamebodyboolean
usePermanentAvatarbodyboolean
userBalancebodynumber
userNavItemsbodystring[]
userTypesbodystring[]
websiteUrlbodystring
widgetItemsbodystring[]

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.


IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page