Hanzo
OpenapiIam

Creates an application or updates it in place, so a deployment can declare the…

Creates an application or updates it in place, so a deployment can declare the applications it needs and run the same declaration on every environment and…

POST /v1/iam/admin/applications/upsert

Addresshttps://api.hanzo.ai/v1/iam/admin/applications/upsert
MethodPOST
OperationupsertApplication
AuthAuthorization: Bearer $HANZO_API_KEY

Creates an application or updates it in place, so a deployment can declare the applications it needs and run the same declaration on every environment and on every redeploy.

It says which of the two it did. Leave the client secret out and the existing one is kept — so re-running your deployment does not rotate a credential your running services are holding.

Request

14 fields, body application/json (required).

FieldInTypeRequiredDescription
Authorizationheaderstring
certbodystring
clientIdbodystring
clientSecretbodystring
displayNamebodystring
enableCodeSigninbodybooleanEnableCodeSignin offers sign-in by an emailed or texted one-time code beside the password.
expireInHoursbodynumberExpireInHours and RefreshExpireInHours are the application's token lifetimes.
grantTypesbodystring[]
isSharedbodybooleanIsShared declares that this application serves EVERY organization, not only the one named in Organization.
namebodystring
organizationbodystring
publicbodybooleanPublic declares a client that CANNOT hold a credential — a browser SPA, a CLI, a desktop app.
redirectUrisbodystring[]
refreshExpireInHoursbodynumber

Response

StatusBodyMeaning
200iam.replyok
400iam.replybad request
401iam.replyunauthorized
500iam.replyinternal server error

200 body — 4 fields.

FieldInTypeAlwaysDescription
actionbodystring
databodyobject
msgbodystring
statusbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo iam admin applications upsert

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page