API Reference
Hanzo IAM API
Hanzo IAM — Identity and Access Management (OAuth2, OIDC, SAML, Web3)
Hanzo IAM — Identity and Access Management (OAuth2, OIDC, SAML, Web3)
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://hanzo.id
| Method | Endpoint | Description |
|---|
GET | /v1/iam/applications | Api Controller Get Applications |
POST | /v1/iam/applications | Api Controller Add Application |
GET | /v1/iam/applications/{id} | Api Controller Get Application |
PUT | /v1/iam/applications/{id} | Api Controller Update Application |
DELETE | /v1/iam/applications/{id} | Api Controller Delete Application |
GET | /v1/iam/organizations/applications | Api Controller Get Organization Applications |
GET | /v1/iam/users/application | Api Controller Get User Application |
| Method | Endpoint | Description |
|---|
GET | /.well-known/{application}/jwks | Root Controller Get Jwks By Application |
GET | /.well-known/{application}/openid-configuration | Root Controller Get Oidc Discovery By Application |
GET | /.well-known/{application}/webfinger | Root Controller Get Web Finger By Application |
GET | /.well-known/jwks | Root Controller Get Jwks |
GET | /.well-known/openid-configuration | Root Controller Get Oidc Discovery |
GET | /.well-known/webfinger | Root Controller Get Web Finger |
POST | /oauth/callback | Api Controller Callback |
POST | /v1/iam/auth/device | Api Controller Device Auth |
GET | /v1/iam/auth/faceid/begin | Api Controller Face ID Signin Begin |
GET | /v1/iam/auth/app-login | Api Controller Get Application Login |
GET | /v1/iam/captcha | Api Controller Get Captcha |
POST | /v1/iam/auth/login | Api Controller Login |
POST | /oauth/introspect | Api Controller Introspect Token |
POST | /v1/iam/auth/logout | Api Controller Logout |
POST | /v1/iam/auth/signup | Api Controller Signup |
GET | /v1/iam/sso-logout | Api Controller Sso Logout |
POST | /v1/iam/sso-logout | Api Controller Sso Logout |
POST | /v1/iam/unlink | Api Controller Unlink |
GET | /v1/iam/auth/webauthn/signin/begin | Api Controller Web Authn Signin Begin |
POST | /v1/iam/auth/webauthn/signin/finish | Api Controller Web Authn Signin Finish |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/payments | Api Controller Get Verifications |
DELETE | /v1/iam/mfa/s/{id} | Api Controller Delete Mfa |
GET | /v1/iam/payments/{id} | Api Controller Get Verification |
GET | /v1/iam/user-payments | Api Controller Get User Verifications |
POST | /v1/iam/mfa/setup/enable | Api Controller Mfa Setup Enable |
POST | /v1/iam/mfa/setup/initiate | Api Controller Mfa Setup Initiate |
POST | /v1/iam/mfa/setup/verify | Api Controller Mfa Setup Verify |
POST | /v1/iam/auth/verification-code/send | Api Controller Send Verification Code |
POST | /v1/iam/mfa/preferred | Api Controller Set Preferred Mfa |
POST | /v1/iam/captcha/verify | Api Controller Verify Captcha |
POST | /v1/iam/auth/verification-code/verify | Api Controller Verify Code |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/groups | Api Controller Get Groups |
POST | /v1/iam/groups | Api Controller Add Group |
GET | /v1/iam/invitations | Api Controller Get Invitations |
POST | /v1/iam/invitations | Api Controller Add Invitation |
GET | /v1/iam/organizations | Api Controller Get Organizations |
POST | /v1/iam/organizations | Api Controller Add Organization |
GET | /v1/iam/groups/{id} | Api Controller Get Group |
PUT | /v1/iam/groups/{id} | Api Controller Update Group |
DELETE | /v1/iam/groups/{id} | Api Controller Delete Group |
GET | /v1/iam/invitations/{id} | Api Controller Get Invitation |
PUT | /v1/iam/invitations/{id} | Api Controller Update Invitation |
DELETE | /v1/iam/invitations/{id} | Api Controller Delete Invitation |
GET | /v1/iam/organizations/{id} | Api Controller Get Organization |
PUT | /v1/iam/organizations/{id} | Api Controller Update Organization |
DELETE | /v1/iam/organizations/{id} | Api Controller Delete Organization |
GET | /v1/iam/applications/default | Api Controller Get Default Application |
GET | /v1/iam/invitation-infos/{id} | Api Controller Get Invitation Code Info |
GET | /v1/iam/organizations/names | Api Controller Get Organization Names |
POST | /v1/iam/invitations/send | Api Controller Verify Invitation |
GET | /v1/iam/invitations/verify | Api Controller Verify Invitation |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/orders | Api Controller Get Orders |
POST | /v1/iam/orders | Api Controller Add Order |
POST | /v1/iam/payments | Api Controller Add Payment |
GET | /v1/iam/plans | Api Controller Get Plans |
POST | /v1/iam/plans | Api Controller Add Plan |
GET | /v1/iam/pricings | Api Controller Get Pricings |
POST | /v1/iam/pricings | Api Controller Add Pricing |
GET | /v1/iam/products | Api Controller Get Products |
POST | /v1/iam/products | Api Controller Add Product |
GET | /v1/iam/subscriptions | Api Controller Get Subscriptions |
POST | /v1/iam/subscriptions | Api Controller Add Subscription |
GET | /v1/iam/transactions | Api Controller Get Transactions |
POST | /v1/iam/transactions | Api Controller Add Transaction |
POST | /v1/iam/orders/cancel | Api Controller Cancel Order |
GET | /v1/iam/orders/{id} | Api Controller Get Order |
PUT | /v1/iam/orders/{id} | Api Controller Update Order |
DELETE | /v1/iam/orders/{id} | Api Controller Delete Order |
PUT | /v1/iam/payments/{id} | Api Controller Update Payment |
DELETE | /v1/iam/payments/{id} | Api Controller Delete Payment |
GET | /v1/iam/plans/{id} | Api Controller Get Plan |
PUT | /v1/iam/plans/{id} | Api Controller Update Plan |
DELETE | /v1/iam/plans/{id} | Api Controller Delete Plan |
GET | /v1/iam/pricings/{id} | Api Controller Get Pricing |
PUT | /v1/iam/pricings/{id} | Api Controller Update Pricing |
DELETE | /v1/iam/pricings/{id} | Api Controller Delete Pricing |
GET | /v1/iam/products/{id} | Api Controller Get Product |
PUT | /v1/iam/products/{id} | Api Controller Update Product |
DELETE | /v1/iam/products/{id} | Api Controller Delete Product |
GET | /v1/iam/subscriptions/{id} | Api Controller Get Subscription |
PUT | /v1/iam/subscriptions/{id} | Api Controller Update Subscription |
DELETE | /v1/iam/subscriptions/{id} | Api Controller Delete Subscription |
GET | /v1/iam/transactions/{id} | Api Controller Get Transaction |
PUT | /v1/iam/transactions/{id} | Api Controller Update Transaction |
DELETE | /v1/iam/transactions/{id} | Api Controller Delete Transaction |
GET | /v1/iam/user-orders | Api Controller Get User Orders |
POST | /v1/iam/invoice-payment | Api Controller Invoice Payment |
POST | /v1/iam/payments/notify | Api Controller Notify Payment |
POST | /v1/iam/pay-order | Api Controller Pay Order |
POST | /v1/iam/place-order | Api Controller Place Order |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/providers | Api Controller Get Providers |
POST | /v1/iam/providers | Api Controller Add Provider |
GET | /v1/iam/providers/{id} | Api Controller Get Provider |
PUT | /v1/iam/providers/{id} | Api Controller Update Provider |
DELETE | /v1/iam/providers/{id} | Api Controller Delete Provider |
GET | /v1/iam/global-providers | Api Controller Get Global Providers |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/resources | Api Controller Get Resources |
POST | /v1/iam/resources | Api Controller Add Resource |
GET | /v1/iam/resources/{id} | Api Controller Get Resource |
PUT | /v1/iam/resources/{id} | Api Controller Update Resource |
DELETE | /v1/iam/resources/{id} | Api Controller Delete Resource |
POST | /v1/iam/resources/upload | Api Controller Upload Resource |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/enforcers | Api Controller Get Enforcers |
POST | /v1/iam/enforcers | Api Controller Add Enforcer |
GET | /v1/iam/models | Api Controller Get Models |
POST | /v1/iam/models | Api Controller Add Model |
GET | /v1/iam/permissions | Api Controller Get Permissions |
POST | /v1/iam/permissions | Api Controller Add Permission |
GET | /v1/iam/policies | Api Controller Get Policies |
POST | /v1/iam/policies | Api Controller Add Policy |
GET | /v1/iam/roles | Api Controller Get Roles |
POST | /v1/iam/roles | Api Controller Add Role |
POST | /v1/iam/enforce/batch | Api Controller Batch Enforce |
GET | /v1/iam/enforcers/{id} | Api Controller Get Enforcer |
PUT | /v1/iam/enforcers/{id} | Api Controller Update Enforcer |
DELETE | /v1/iam/enforcers/{id} | Api Controller Delete Enforcer |
GET | /v1/iam/models/{id} | Api Controller Get Model |
PUT | /v1/iam/models/{id} | Api Controller Update Model |
DELETE | /v1/iam/models/{id} | Api Controller Delete Model |
GET | /v1/iam/permissions/{id} | Api Controller Get Permission |
PUT | /v1/iam/permissions/{id} | Api Controller Update Permission |
DELETE | /v1/iam/permissions/{id} | Api Controller Delete Permission |
GET | /v1/iam/roles/{id} | Api Controller Get Role |
PUT | /v1/iam/roles/{id} | Api Controller Update Role |
DELETE | /v1/iam/roles/{id} | Api Controller Delete Role |
POST | /v1/iam/enforce | Api Controller Enforce |
GET | /v1/iam/all-actions | Api Controller Get All Actions |
GET | /v1/iam/all-objects | Api Controller Get All Objects |
GET | /v1/iam/all-roles | Api Controller Get All Roles |
GET | /v1/iam/filtered-policies | Api Controller Get Filtered Policies |
GET | /v1/iam/permissions-by-roles/{id} | Api Controller Get Permissions By Role |
GET | /v1/iam/permissions-by-submitters/{id} | Api Controller Get Permissions By Submitter |
POST | /v1/iam/remove-policy | Api Controller Remove Policy |
GET | /v1/iam/run-casbin-command | Api Controller Run Casbin Command |
PUT | /v1/iam/policies/{id} | Api Controller Update Policy |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/sessions | Api Controller Get Sessions |
POST | /v1/iam/sessions | Api Controller Add Session |
GET | /v1/iam/sessions/{id} | Api Controller Get Single Session |
PUT | /v1/iam/sessions/{id} | Api Controller Update Session |
DELETE | /v1/iam/sessions/{id} | Api Controller Delete Session |
GET | /v1/iam/is-session-duplicated | Api Controller Is Session Duplicated |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/adapters | Api Controller Get Adapters |
POST | /v1/iam/adapters | Api Controller Add Adapter |
GET | /v1/iam/certs | Api Controller Get Certs |
POST | /v1/iam/certs | Api Controller Add Cert |
GET | /v1/iam/forms | Api Controller Get Forms |
POST | /v1/iam/forms | Api Controller Add Form |
GET | /v1/iam/records | Api Controller Get Records |
POST | /v1/iam/records | Api Controller Add Record |
GET | /v1/iam/syncers | Api Controller Get Syncers |
POST | /v1/iam/syncers | Api Controller Add Syncer |
GET | /v1/iam/tickets | Api Controller Get Tickets |
POST | /v1/iam/tickets | Api Controller Add Ticket |
POST | /v1/iam/ticket-messages | Api Controller Add Ticket Message |
GET | /v1/iam/adapters/{id} | Api Controller Get Adapter |
PUT | /v1/iam/adapters/{id} | Api Controller Update Adapter |
DELETE | /v1/iam/adapters/{id} | Api Controller Delete Adapter |
GET | /v1/iam/certs/{id} | Api Controller Get Cert |
PUT | /v1/iam/certs/{id} | Api Controller Update Cert |
DELETE | /v1/iam/certs/{id} | Api Controller Delete Cert |
GET | /v1/iam/forms/{id} | Api Controller Get Form |
PUT | /v1/iam/forms/{id} | Api Controller Update Form |
DELETE | /v1/iam/forms/{id} | Api Controller Delete Form |
GET | /v1/iam/syncers/{id} | Api Controller Get Syncer |
PUT | /v1/iam/syncers/{id} | Api Controller Update Syncer |
DELETE | /v1/iam/syncers/{id} | Api Controller Delete Syncer |
GET | /v1/iam/tickets/{id} | Api Controller Get Ticket |
PUT | /v1/iam/tickets/{id} | Api Controller Update Ticket |
DELETE | /v1/iam/tickets/{id} | Api Controller Delete Ticket |
GET | /v1/iam/dashboard | Api Controller Get Dashboard |
GET | /v1/iam/global-certs | Api Controller Get Global Certs |
GET | /v1/iam/global-forms | Api Controller Get Global Forms |
GET | /v1/iam/metrics/prometheus | Api Controller Get Prometheus Info |
GET | /v1/iam/qrcodes/{id} | Api Controller Get Wechat QR Code |
GET | /v1/iam/records-filters/{id} | Api Controller Get Records By Filter |
GET | /v1/iam/system | Api Controller Get System Info |
GET | /v1/iam/version-infos/{id} | Api Controller Get Version Info |
GET | /v1/iam/webhook-events/{id} | Api Controller Get Webhook Event Type |
GET | /v1/iam/health | Api Controller Health |
GET | /v1/iam/metrics | Api Controller Get Metrics |
POST | /v1/iam/refresh-engines | Api Controller Refresh Engines |
GET | /v1/iam/syncers/run | Api Controller Run Syncer |
POST | /v1/iam/messaging/email | Api Controller Send Email |
POST | /v1/iam/messaging/notification | Api Controller Send Notification |
POST | /v1/iam/messaging/sms | Api Controller Send Sms |
POST | /v1/iam/webhook | Api Controller Handle Official Account Event |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/tokens | Api Controller Get Tokens |
POST | /v1/iam/tokens | Api Controller Add Token |
GET | /v1/iam/tokens/{id} | Api Controller Get Token |
PUT | /v1/iam/tokens/{id} | Api Controller Update Token |
DELETE | /v1/iam/tokens/{id} | Api Controller Delete Token |
GET | /v1/iam/captcha/status | Api Controller Get Captcha Status |
POST | /oauth/token | Api Controller Get O Auth Token |
POST | /oauth/token/refresh | Api Controller Refresh Token |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/ldaps | Api Controller Get Ldaps |
POST | /v1/iam/ldaps | Api Controller Add Ldap |
GET | /v1/iam/users | Api Controller Get Users |
POST | /v1/iam/users | Api Controller Add User |
POST | /v1/iam/user-keys | Api Controller Add User Keys |
POST | /v1/iam/auth/check-password | Api Controller Check User Password |
GET | /v1/iam/ldaps/{id} | Api Controller Get Ldap |
PUT | /v1/iam/ldaps/{id} | Api Controller Update Ldap |
DELETE | /v1/iam/ldaps/{id} | Api Controller Delete Ldap |
GET | /v1/iam/users/{id} | Api Controller Get User |
PUT | /v1/iam/users/{id} | Api Controller Update User |
DELETE | /v1/iam/users/{id} | Api Controller Delete User |
POST | /v1/iam/impersonation/exit | Api Controller Exit Impersonate User |
GET | /v1/iam/accounts/{id} | Api Controller Get Account |
GET | /v1/iam/auth/contact | Api Controller Get Email And Phone |
GET | /v1/iam/global-users | Api Controller Get Global Users |
GET | /v1/iam/ldap-users | Api Controller Get Ldapser |
GET | /v1/iam/sorted-users | Api Controller Get Sorted Users |
GET | /v1/iam/user-counts/{id} | Api Controller Get User Count |
POST | /v1/iam/impersonation-user | Api Controller Impersonate User |
POST | /v1/iam/auth/reset-contact | Api Controller Reset Email Or Phone |
POST | /v1/iam/auth/set-password | Api Controller Set Password |
POST | /v1/iam/ldap/sync | Api Controller Sync Ldap Users |
GET | /v1/iam/user | Api Controller User Info2 |
GET | /oauth/userinfo | Api Controller User Info |
POST | /v1/iam/auth/identification/verify | Api Controller Verify Identification |
GET | /v1/iam/auth/webauthn/signup/begin | Api Controller Web Authn Signup Begin |
POST | /v1/iam/auth/webauthn/signup/finish | Api Controller Web Authn Signup Finish |
| Method | Endpoint | Description |
|---|
GET | /v1/iam/webhooks | Api Controller Get Webhooks |
POST | /v1/iam/webhooks | Api Controller Add Webhook |
GET | /v1/iam/webhooks/{id} | Api Controller Get Webhook |
PUT | /v1/iam/webhooks/{id} | Api Controller Update Webhook |
DELETE | /v1/iam/webhooks/{id} | Api Controller Delete Webhook |
Hanzo IAM API guide · All Hanzo APIs · OpenAPI spec
How is this guide?