OpenapiIam
Registers an application in your organization — one product or site your people…
Registers an application in your organization — one product or site your people sign in to, with its own client credentials, sign-in methods and allowed…
POST /v1/iam/applications
| Address | https://api.hanzo.ai/v1/iam/applications |
| Method | POST |
| Operation | post_iam_applications |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Registers an application in your organization — one product or site your people sign in to, with its own client credentials, sign-in methods and allowed redirect URIs. A name already used in the organization is refused rather than overwritten.
Exported so the legacy add-application alias reuses this exact path — one create, two spellings.
Request
285 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
affiliationUrl | body | string | — | |
category | body | string | — | |
cert | body | string | — | |
certObj | body | iam.Cert | — | |
certObj.accessKey | body | string | — | |
certObj.accessSecret | body | string | — | |
certObj.account | body | string | — | |
certObj.bitSize | body | integer | — | |
certObj.certificate | body | string | — | |
certObj.createdAt | body | string (date-time) | — | |
certObj.createdTime | body | string | — | |
certObj.cryptoAlgorithm | body | string | — | |
certObj.deleted | body | boolean | — | |
certObj.displayName | body | string | — | |
certObj.domainExpireTime | body | string | — | |
certObj.expireInYears | body | integer | — | |
certObj.expireTime | body | string | — | |
certObj.id | body | string | — | |
certObj.name | body | string | — | |
certObj.owner | body | string | — | |
certObj.provider | body | string | — | |
certObj.scope | body | string | — | |
certObj.type | body | string | — | |
certObj.updatedAt | body | string (date-time) | — | |
certPublicKey | body | string | — | |
clientCert | body | string | — | |
clientId | body | string | — | ClientId is the OAuth2/OIDC client identifier and the GLOBAL key every confidential-client resolver authenticates against (store.GetApplicationByClientId, the… |
clientSecret | body | string | — | |
codeResendTimeout | body | integer | — | |
cookieExpireInHours | body | integer | — | |
createdAt | body | string (date-time) | — | |
createdTime | body | string | — | |
customScopes | body | iam.ScopeDescription[] | — | |
customScopes[].description | body | string | — | |
customScopes[].displayName | body | string | — | |
customScopes[].scope | body | string | — | |
defaultGroup | body | string | — | |
deleted | body | boolean | — | |
description | body | string | — | |
disableSamlAttributes | body | boolean | — | |
disableSignin | body | boolean | — | |
displayName | body | string | — | |
domain | body | string | — | |
enableAutoSignin | body | boolean | — | |
enableCodeSignin | body | boolean | — | |
enableExclusiveSignin | body | boolean | — | |
enableLinkWithEmail | body | boolean | — | |
enablePassword | body | boolean | — | |
enableSamlAssertionSignature | body | boolean | — | |
enableSamlC14n10 | body | boolean | — | |
enableSamlCompress | body | boolean | — | |
enableSamlPostBinding | body | boolean | — | |
enableSignUp | body | boolean | — | |
enableSigninSession | body | boolean | — | |
enableWebAuthn | body | boolean | — | |
environment | body | string | — | |
expireInHours | body | number | — | |
failedSigninFrozenTime | body | integer | — | |
failedSigninLimit | body | integer | — | |
favicon | body | string | — | |
footerHtml | body | string | — | |
forcedRedirectOrigin | body | string | — | |
forgetUrl | body | string | — | |
formBackgroundUrl | body | string | — | |
formBackgroundUrlMobile | body | string | — | |
formCss | body | string | — | |
formCssMobile | body | string | — | |
formOffset | body | integer | — | |
formSideHtml | body | string | — | |
grantTypes | body | string[] | — | |
headerHtml | body | string | — | |
homepageUrl | body | string | — | |
id | body | string | — | |
ipRestriction | body | string | — | |
ipWhitelist | body | string | — | |
isShared | body | boolean | — | |
logo | body | string | — | |
name | body | string | — | |
order | body | integer | — | |
orgChoiceMode | body | string | — | |
organization | body | string | — | |
organizationObj | body | iam.Organization | — | |
organizationObj.accountItems | body | iam.AccountItem[] | — | |
organizationObj.accountItems[].modifyRule | body | string | — | |
organizationObj.accountItems[].name | body | string | — | |
organizationObj.accountItems[].regex | body | string | — | |
organizationObj.accountItems[].tab | body | string | — | |
organizationObj.accountItems[].viewRule | body | string | — | |
organizationObj.accountItems[].visible | body | boolean | — | |
organizationObj.accountMenu | body | string | — | |
organizationObj.avatar | body | string | — | How the organization appears across Hanzo — the square mark beside its name — as an image or as one emoji, never both. |
organizationObj.balanceCredit | body | number | — | |
organizationObj.balanceCurrency | body | string | — | |
organizationObj.countryCodes | body | string[] | — | |
organizationObj.createdAt | body | string (date-time) | — | |
organizationObj.createdTime | body | string | — | |
organizationObj.dcrPolicy | body | string | — | |
organizationObj.defaultApplication | body | string | — | |
organizationObj.defaultAvatar | body | string | — | |
organizationObj.defaultPassword | body | string | — | |
organizationObj.deleted | body | boolean | — | |
organizationObj.disableSignin | body | boolean | — | |
organizationObj.displayName | body | string | — | |
organizationObj.emoji | body | string | — | |
organizationObj.enableSoftDeletion | body | boolean | — | |
organizationObj.enableTour | body | boolean | — | |
organizationObj.failedSigninFrozenTime | body | integer | — | |
organizationObj.failedSigninLimit | body | integer | — | Per-organization signin throttle. Zero means "inherit the application default"; a non-zero value overrides it. |
organizationObj.favicon | body | string | — | |
organizationObj.founder | body | string | — | Founder is the stable storage id of the identity that provisioned this org (self-service onboarding). |
organizationObj.hasPrivilegeConsent | body | boolean | — | |
organizationObj.id | body | string | — | |
organizationObj.initScore | body | integer | — | |
organizationObj.ipRestriction | body | string | — | |
organizationObj.ipWhitelist | body | string | — | |
organizationObj.isPersonal | body | boolean | — | |
organizationObj.isProfilePublic | body | boolean | — | |
organizationObj.kerberosKdcHost | body | string | — | |
organizationObj.kerberosKeytab | body | string | — | |
organizationObj.kerberosRealm | body | string | — | |
organizationObj.kerberosServiceName | body | string | — | |
organizationObj.languages | body | string[] | — | |
organizationObj.ldapAttributes | body | string[] | — | |
organizationObj.logo | body | string | — | |
organizationObj.logoDark | body | string | — | |
organizationObj.masterPassword | body | string | — | |
organizationObj.masterVerificationCode | body | string | — | |
organizationObj.mfaItems | body | iam.MfaItem[] | — | |
organizationObj.mfaItems[].name | body | string | — | |
organizationObj.mfaItems[].rule | body | string | — | |
organizationObj.mfaRememberInHours | body | integer | — | |
organizationObj.name | body | string | — | |
organizationObj.navItems | body | string[] | — | |
organizationObj.orgBalance | body | number | — | Balance fields are read-only mirrors; authoritative balances live in Commerce (billing.hanzo.ai). |
organizationObj.owner | body | string | — | |
organizationObj.passwordExpireDays | body | integer | — | |
organizationObj.passwordObfuscatorKey | body | string | — | |
organizationObj.passwordObfuscatorType | body | string | — | |
organizationObj.passwordOptions | body | string[] | — | |
organizationObj.passwordSalt | body | string | — | |
organizationObj.passwordType | body | string | — | |
organizationObj.tags | body | string[] | — | |
organizationObj.themeData | body | iam.ThemeData | — | |
organizationObj.themeData.borderRadius | body | integer | — | |
organizationObj.themeData.colorPrimary | body | string | — | |
organizationObj.themeData.isCompact | body | boolean | — | |
organizationObj.themeData.isEnabled | body | boolean | — | |
organizationObj.themeData.themeType | body | string | — | |
organizationObj.updatedAt | body | string (date-time) | — | |
organizationObj.useEmailAsUsername | body | boolean | — | |
organizationObj.usePermanentAvatar | body | boolean | — | |
organizationObj.userBalance | body | number | — | |
organizationObj.userNavItems | body | string[] | — | |
organizationObj.userTypes | body | string[] | — | |
organizationObj.websiteUrl | body | string | — | |
organizationObj.widgetItems | body | string[] | — | |
otherDomains | body | string[] | — | |
owner | body | string | — | |
project | body | string | — | |
providers | body | iam.ProviderItem[] | — | |
providers[].bindingRule | body | string[] | — | |
providers[].canSignIn | body | boolean | — | |
providers[].canSignUp | body | boolean | — | |
providers[].canUnlink | body | boolean | — | |
providers[].countryCodes | body | string[] | — | |
providers[].name | body | string | — | |
providers[].owner | body | string | — | |
providers[].prompted | body | boolean | — | |
providers[].provider | body | iam.Provider | — | |
providers[].provider.appId | body | string | — | |
providers[].provider.bucket | body | string | — | |
providers[].provider.category | body | string | — | |
providers[].provider.cert | body | string | — | |
providers[].provider.clientId | body | string | — | |
providers[].provider.clientId2 | body | string | — | |
providers[].provider.clientSecret | body | string | — | |
providers[].provider.clientSecret2 | body | string | — | |
providers[].provider.content | body | string | — | |
providers[].provider.createdAt | body | string (date-time) | — | |
providers[].provider.createdTime | body | string | — | |
providers[].provider.customAuthUrl | body | string | — | |
providers[].provider.customLogo | body | string | — | |
providers[].provider.customTokenUrl | body | string | — | |
providers[].provider.customUserInfoUrl | body | string | — | |
providers[].provider.deleted | body | boolean | — | |
providers[].provider.disableSsl | body | boolean | — | |
providers[].provider.displayName | body | string | — | |
providers[].provider.domain | body | string | — | |
providers[].provider.emailRegex | body | string | — | |
providers[].provider.enablePkce | body | boolean | — | |
providers[].provider.enableProxy | body | boolean | — | |
providers[].provider.enableSignAuthnRequest | body | boolean | — | |
providers[].provider.endpoint | body | string | — | |
providers[].provider.host | body | string | — | |
providers[].provider.httpHeaders | body | object | — | |
providers[].provider.httpHeaders.* | body | string | — | |
providers[].provider.id | body | string | — | |
providers[].provider.idP | body | string | — | |
providers[].provider.intranetEndpoint | body | string | — | |
providers[].provider.issuerUrl | body | string | — | |
providers[].provider.metadata | body | string | — | |
providers[].provider.method | body | string | — | |
providers[].provider.name | body | string | — | |
providers[].provider.owner | body | string | — | |
providers[].provider.pathPrefix | body | string | — | |
providers[].provider.port | body | integer | — | |
providers[].provider.providerUrl | body | string | — | |
providers[].provider.receiver | body | string | — | |
providers[].provider.regionId | body | string | — | |
providers[].provider.scopes | body | string | — | |
providers[].provider.signName | body | string | — | |
providers[].provider.sslMode | body | string | — | |
providers[].provider.subType | body | string | — | |
providers[].provider.templateCode | body | string | — | |
providers[].provider.title | body | string | — | |
providers[].provider.type | body | string | — | |
providers[].provider.updatedAt | body | string (date-time) | — | |
providers[].provider.userMapping | body | object | — | |
providers[].provider.userMapping.* | body | string | — | |
providers[].rule | body | string | — | |
providers[].signupGroup | body | string | — | |
redirectUris | body | string[] | — | |
refreshExpireInHours | body | number | — | |
samlAttributes | body | iam.SamlItem[] | — | |
samlAttributes[].name | body | string | — | |
samlAttributes[].nameFormat | body | string | — | |
samlAttributes[].value | body | string | — | |
samlHashAlgorithm | body | string | — | |
samlReplyUrl | body | string | — | |
scopes | body | iam.ScopeItem[] | — | |
scopes[].description | body | string | — | |
scopes[].displayName | body | string | — | |
scopes[].name | body | string | — | |
scopes[].tools | body | string[] | — | |
signinHtml | body | string | — | |
signinItems | body | iam.SigninItem[] | — | |
signinItems[].customCss | body | string | — | |
signinItems[].isCustom | body | boolean | — | |
signinItems[].label | body | string | — | |
signinItems[].name | body | string | — | |
signinItems[].placeholder | body | string | — | |
signinItems[].rule | body | string | — | |
signinItems[].visible | body | boolean | — | |
signinMethods | body | iam.SigninMethod[] | — | |
signinMethods[].displayName | body | string | — | |
signinMethods[].name | body | string | — | |
signinMethods[].rule | body | string | — | |
signinUrl | body | string | — | |
signupHtml | body | string | — | |
signupItems | body | iam.SignupItem[] | — | |
signupItems[].customCss | body | string | — | |
signupItems[].label | body | string | — | |
signupItems[].name | body | string | — | |
signupItems[].options | body | string[] | — | |
signupItems[].placeholder | body | string | — | |
signupItems[].prompted | body | boolean | — | |
signupItems[].regex | body | string | — | |
signupItems[].required | body | boolean | — | |
signupItems[].rule | body | string | — | |
signupItems[].type | body | string | — | |
signupItems[].visible | body | boolean | — | |
signupUrl | body | string | — | |
sslCert | body | string | — | |
sslMode | body | string | — | |
tags | body | string[] | — | |
termsOfUse | body | string | — | |
themeData | body | iam.ThemeData | — | |
themeData.borderRadius | body | integer | — | |
themeData.colorPrimary | body | string | — | |
themeData.isCompact | body | boolean | — | |
themeData.isEnabled | body | boolean | — | |
themeData.themeType | body | string | — | |
title | body | string | — | |
tokenAttributes | body | iam.JwtItem[] | — | |
tokenAttributes[].category | body | string | — | |
tokenAttributes[].name | body | string | — | |
tokenAttributes[].type | body | string | — | |
tokenAttributes[].value | body | string | — | |
tokenFields | body | string[] | — | |
tokenFormat | body | string | — | |
tokenSigningMethod | body | string | — | |
type | body | string | — | |
updatedAt | body | string (date-time) | — | |
upstreamHost | body | string | — | |
useEmailAsSamlNameId | body | boolean | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | iam.Application | ok |
200 body — 285 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
affiliationUrl | body | string | — | |
category | body | string | — | |
cert | body | string | — | |
certObj | body | iam.Cert | — | |
certObj.accessKey | body | string | — | |
certObj.accessSecret | body | string | — | |
certObj.account | body | string | — | |
certObj.bitSize | body | integer | — | |
certObj.certificate | body | string | — | |
certObj.createdAt | body | string (date-time) | — | |
certObj.createdTime | body | string | — | |
certObj.cryptoAlgorithm | body | string | — | |
certObj.deleted | body | boolean | — | |
certObj.displayName | body | string | — | |
certObj.domainExpireTime | body | string | — | |
certObj.expireInYears | body | integer | — | |
certObj.expireTime | body | string | — | |
certObj.id | body | string | — | |
certObj.name | body | string | — | |
certObj.owner | body | string | — | |
certObj.provider | body | string | — | |
certObj.scope | body | string | — | |
certObj.type | body | string | — | |
certObj.updatedAt | body | string (date-time) | — | |
certPublicKey | body | string | — | |
clientCert | body | string | — | |
clientId | body | string | — | ClientId is the OAuth2/OIDC client identifier and the GLOBAL key every confidential-client resolver authenticates against (store.GetApplicationByClientId, the… |
clientSecret | body | string | — | |
codeResendTimeout | body | integer | — | |
cookieExpireInHours | body | integer | — | |
createdAt | body | string (date-time) | — | |
createdTime | body | string | — | |
customScopes | body | iam.ScopeDescription[] | — | |
customScopes[].description | body | string | — | |
customScopes[].displayName | body | string | — | |
customScopes[].scope | body | string | — | |
defaultGroup | body | string | — | |
deleted | body | boolean | — | |
description | body | string | — | |
disableSamlAttributes | body | boolean | — | |
disableSignin | body | boolean | — | |
displayName | body | string | — | |
domain | body | string | — | |
enableAutoSignin | body | boolean | — | |
enableCodeSignin | body | boolean | — | |
enableExclusiveSignin | body | boolean | — | |
enableLinkWithEmail | body | boolean | — | |
enablePassword | body | boolean | — | |
enableSamlAssertionSignature | body | boolean | — | |
enableSamlC14n10 | body | boolean | — | |
enableSamlCompress | body | boolean | — | |
enableSamlPostBinding | body | boolean | — | |
enableSignUp | body | boolean | — | |
enableSigninSession | body | boolean | — | |
enableWebAuthn | body | boolean | — | |
environment | body | string | — | |
expireInHours | body | number | — | |
failedSigninFrozenTime | body | integer | — | |
failedSigninLimit | body | integer | — | |
favicon | body | string | — | |
footerHtml | body | string | — | |
forcedRedirectOrigin | body | string | — | |
forgetUrl | body | string | — | |
formBackgroundUrl | body | string | — | |
formBackgroundUrlMobile | body | string | — | |
formCss | body | string | — | |
formCssMobile | body | string | — | |
formOffset | body | integer | — | |
formSideHtml | body | string | — | |
grantTypes | body | string[] | — | |
headerHtml | body | string | — | |
homepageUrl | body | string | — | |
id | body | string | — | |
ipRestriction | body | string | — | |
ipWhitelist | body | string | — | |
isShared | body | boolean | — | |
logo | body | string | — | |
name | body | string | — | |
order | body | integer | — | |
orgChoiceMode | body | string | — | |
organization | body | string | — | |
organizationObj | body | iam.Organization | — | |
organizationObj.accountItems | body | iam.AccountItem[] | — | |
organizationObj.accountItems[].modifyRule | body | string | — | |
organizationObj.accountItems[].name | body | string | — | |
organizationObj.accountItems[].regex | body | string | — | |
organizationObj.accountItems[].tab | body | string | — | |
organizationObj.accountItems[].viewRule | body | string | — | |
organizationObj.accountItems[].visible | body | boolean | — | |
organizationObj.accountMenu | body | string | — | |
organizationObj.avatar | body | string | — | How the organization appears across Hanzo — the square mark beside its name — as an image or as one emoji, never both. |
organizationObj.balanceCredit | body | number | — | |
organizationObj.balanceCurrency | body | string | — | |
organizationObj.countryCodes | body | string[] | — | |
organizationObj.createdAt | body | string (date-time) | — | |
organizationObj.createdTime | body | string | — | |
organizationObj.dcrPolicy | body | string | — | |
organizationObj.defaultApplication | body | string | — | |
organizationObj.defaultAvatar | body | string | — | |
organizationObj.defaultPassword | body | string | — | |
organizationObj.deleted | body | boolean | — | |
organizationObj.disableSignin | body | boolean | — | |
organizationObj.displayName | body | string | — | |
organizationObj.emoji | body | string | — | |
organizationObj.enableSoftDeletion | body | boolean | — | |
organizationObj.enableTour | body | boolean | — | |
organizationObj.failedSigninFrozenTime | body | integer | — | |
organizationObj.failedSigninLimit | body | integer | — | Per-organization signin throttle. Zero means "inherit the application default"; a non-zero value overrides it. |
organizationObj.favicon | body | string | — | |
organizationObj.founder | body | string | — | Founder is the stable storage id of the identity that provisioned this org (self-service onboarding). |
organizationObj.hasPrivilegeConsent | body | boolean | — | |
organizationObj.id | body | string | — | |
organizationObj.initScore | body | integer | — | |
organizationObj.ipRestriction | body | string | — | |
organizationObj.ipWhitelist | body | string | — | |
organizationObj.isPersonal | body | boolean | — | |
organizationObj.isProfilePublic | body | boolean | — | |
organizationObj.kerberosKdcHost | body | string | — | |
organizationObj.kerberosKeytab | body | string | — | |
organizationObj.kerberosRealm | body | string | — | |
organizationObj.kerberosServiceName | body | string | — | |
organizationObj.languages | body | string[] | — | |
organizationObj.ldapAttributes | body | string[] | — | |
organizationObj.logo | body | string | — | |
organizationObj.logoDark | body | string | — | |
organizationObj.masterPassword | body | string | — | |
organizationObj.masterVerificationCode | body | string | — | |
organizationObj.mfaItems | body | iam.MfaItem[] | — | |
organizationObj.mfaItems[].name | body | string | — | |
organizationObj.mfaItems[].rule | body | string | — | |
organizationObj.mfaRememberInHours | body | integer | — | |
organizationObj.name | body | string | — | |
organizationObj.navItems | body | string[] | — | |
organizationObj.orgBalance | body | number | — | Balance fields are read-only mirrors; authoritative balances live in Commerce (billing.hanzo.ai). |
organizationObj.owner | body | string | — | |
organizationObj.passwordExpireDays | body | integer | — | |
organizationObj.passwordObfuscatorKey | body | string | — | |
organizationObj.passwordObfuscatorType | body | string | — | |
organizationObj.passwordOptions | body | string[] | — | |
organizationObj.passwordSalt | body | string | — | |
organizationObj.passwordType | body | string | — | |
organizationObj.tags | body | string[] | — | |
organizationObj.themeData | body | iam.ThemeData | — | |
organizationObj.themeData.borderRadius | body | integer | — | |
organizationObj.themeData.colorPrimary | body | string | — | |
organizationObj.themeData.isCompact | body | boolean | — | |
organizationObj.themeData.isEnabled | body | boolean | — | |
organizationObj.themeData.themeType | body | string | — | |
organizationObj.updatedAt | body | string (date-time) | — | |
organizationObj.useEmailAsUsername | body | boolean | — | |
organizationObj.usePermanentAvatar | body | boolean | — | |
organizationObj.userBalance | body | number | — | |
organizationObj.userNavItems | body | string[] | — | |
organizationObj.userTypes | body | string[] | — | |
organizationObj.websiteUrl | body | string | — | |
organizationObj.widgetItems | body | string[] | — | |
otherDomains | body | string[] | — | |
owner | body | string | — | |
project | body | string | — | |
providers | body | iam.ProviderItem[] | — | |
providers[].bindingRule | body | string[] | — | |
providers[].canSignIn | body | boolean | — | |
providers[].canSignUp | body | boolean | — | |
providers[].canUnlink | body | boolean | — | |
providers[].countryCodes | body | string[] | — | |
providers[].name | body | string | — | |
providers[].owner | body | string | — | |
providers[].prompted | body | boolean | — | |
providers[].provider | body | iam.Provider | — | |
providers[].provider.appId | body | string | — | |
providers[].provider.bucket | body | string | — | |
providers[].provider.category | body | string | — | |
providers[].provider.cert | body | string | — | |
providers[].provider.clientId | body | string | — | |
providers[].provider.clientId2 | body | string | — | |
providers[].provider.clientSecret | body | string | — | |
providers[].provider.clientSecret2 | body | string | — | |
providers[].provider.content | body | string | — | |
providers[].provider.createdAt | body | string (date-time) | — | |
providers[].provider.createdTime | body | string | — | |
providers[].provider.customAuthUrl | body | string | — | |
providers[].provider.customLogo | body | string | — | |
providers[].provider.customTokenUrl | body | string | — | |
providers[].provider.customUserInfoUrl | body | string | — | |
providers[].provider.deleted | body | boolean | — | |
providers[].provider.disableSsl | body | boolean | — | |
providers[].provider.displayName | body | string | — | |
providers[].provider.domain | body | string | — | |
providers[].provider.emailRegex | body | string | — | |
providers[].provider.enablePkce | body | boolean | — | |
providers[].provider.enableProxy | body | boolean | — | |
providers[].provider.enableSignAuthnRequest | body | boolean | — | |
providers[].provider.endpoint | body | string | — | |
providers[].provider.host | body | string | — | |
providers[].provider.httpHeaders | body | object | — | |
providers[].provider.httpHeaders.* | body | string | — | |
providers[].provider.id | body | string | — | |
providers[].provider.idP | body | string | — | |
providers[].provider.intranetEndpoint | body | string | — | |
providers[].provider.issuerUrl | body | string | — | |
providers[].provider.metadata | body | string | — | |
providers[].provider.method | body | string | — | |
providers[].provider.name | body | string | — | |
providers[].provider.owner | body | string | — | |
providers[].provider.pathPrefix | body | string | — | |
providers[].provider.port | body | integer | — | |
providers[].provider.providerUrl | body | string | — | |
providers[].provider.receiver | body | string | — | |
providers[].provider.regionId | body | string | — | |
providers[].provider.scopes | body | string | — | |
providers[].provider.signName | body | string | — | |
providers[].provider.sslMode | body | string | — | |
providers[].provider.subType | body | string | — | |
providers[].provider.templateCode | body | string | — | |
providers[].provider.title | body | string | — | |
providers[].provider.type | body | string | — | |
providers[].provider.updatedAt | body | string (date-time) | — | |
providers[].provider.userMapping | body | object | — | |
providers[].provider.userMapping.* | body | string | — | |
providers[].rule | body | string | — | |
providers[].signupGroup | body | string | — | |
redirectUris | body | string[] | — | |
refreshExpireInHours | body | number | — | |
samlAttributes | body | iam.SamlItem[] | — | |
samlAttributes[].name | body | string | — | |
samlAttributes[].nameFormat | body | string | — | |
samlAttributes[].value | body | string | — | |
samlHashAlgorithm | body | string | — | |
samlReplyUrl | body | string | — | |
scopes | body | iam.ScopeItem[] | — | |
scopes[].description | body | string | — | |
scopes[].displayName | body | string | — | |
scopes[].name | body | string | — | |
scopes[].tools | body | string[] | — | |
signinHtml | body | string | — | |
signinItems | body | iam.SigninItem[] | — | |
signinItems[].customCss | body | string | — | |
signinItems[].isCustom | body | boolean | — | |
signinItems[].label | body | string | — | |
signinItems[].name | body | string | — | |
signinItems[].placeholder | body | string | — | |
signinItems[].rule | body | string | — | |
signinItems[].visible | body | boolean | — | |
signinMethods | body | iam.SigninMethod[] | — | |
signinMethods[].displayName | body | string | — | |
signinMethods[].name | body | string | — | |
signinMethods[].rule | body | string | — | |
signinUrl | body | string | — | |
signupHtml | body | string | — | |
signupItems | body | iam.SignupItem[] | — | |
signupItems[].customCss | body | string | — | |
signupItems[].label | body | string | — | |
signupItems[].name | body | string | — | |
signupItems[].options | body | string[] | — | |
signupItems[].placeholder | body | string | — | |
signupItems[].prompted | body | boolean | — | |
signupItems[].regex | body | string | — | |
signupItems[].required | body | boolean | — | |
signupItems[].rule | body | string | — | |
signupItems[].type | body | string | — | |
signupItems[].visible | body | boolean | — | |
signupUrl | body | string | — | |
sslCert | body | string | — | |
sslMode | body | string | — | |
tags | body | string[] | — | |
termsOfUse | body | string | — | |
themeData | body | iam.ThemeData | — | |
themeData.borderRadius | body | integer | — | |
themeData.colorPrimary | body | string | — | |
themeData.isCompact | body | boolean | — | |
themeData.isEnabled | body | boolean | — | |
themeData.themeType | body | string | — | |
title | body | string | — | |
tokenAttributes | body | iam.JwtItem[] | — | |
tokenAttributes[].category | body | string | — | |
tokenAttributes[].name | body | string | — | |
tokenAttributes[].type | body | string | — | |
tokenAttributes[].value | body | string | — | |
tokenFields | body | string[] | — | |
tokenFormat | body | string | — | |
tokenSigningMethod | body | string | — | |
type | body | string | — | |
updatedAt | body | string (date-time) | — | |
upstreamHost | body | string | — | |
useEmailAsSamlNameId | body | boolean | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo iam applications createimport { Configuration, IamApi } from 'hanzoai';
const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postIamApplications({ affiliationUrl: "<affiliationUrl>", category: "<category>" });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).post_iam_applications(affiliation_url="<affiliationUrl>", category="<category>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IamAPI.PostIamApplications(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::post_iam_applications(&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).postIamApplications();curl -X POST https://api.hanzo.ai/v1/iam/applications \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"affiliationUrl": "<affiliationUrl>",
"category": "<category>"
}'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?