Creates a person or updates them in place, so a deployment can declare the…
Creates a person or updates them in place, so a deployment can declare the accounts it needs and re-run that declaration safely.
POST /v1/iam/admin/users/upsert
| Address | https://api.hanzo.ai/v1/iam/admin/users/upsert |
| Method | POST |
| Operation | upsertUser |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Creates a person or updates them in place, so a deployment can declare the accounts it needs and re-run that declaration safely.
It DESCRIBES an account it meets and GRANTS only to one it creates: org-admin is never raised on a row that already exists, and a machine identity is answered by name rather than adopted. Both are properties of the update itself, so a steady-state reconcile — which changes neither — is unaffected.
Passwords are hashed before they are stored. Leave the password out and their current one is kept, so a redeploy never locks somebody out; send the same one again and it is kept too, so a steady-state re-run is not a rotation.
Request
9 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
Authorization | header | string | — | |
displayName | body | string | — | |
email | body | string | — | |
isAdmin | body | boolean | — | |
name | body | string | — | |
owner | body | string | — | |
password | body | string | — | |
passwordType | body | string | — | |
phone | body | string | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | iam.reply | ok |
400 | iam.reply | bad request |
401 | iam.reply | unauthorized |
500 | iam.reply | internal server error |
200 body — 4 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
action | body | string | — | |
data | body | object | — | |
msg | body | string | — | |
status | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo iam admin users upsertimport { Configuration, IamApi } from 'hanzoai';
const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.upsertUser({ displayName: "<displayName>", email: "<email>" });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).upsert_user(display_name="<displayName>", email="<email>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IamAPI.UpsertUser(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::upsert_user(&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).upsertUser();curl -X POST https://api.hanzo.ai/v1/iam/admin/users/upsert \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"displayName": "<displayName>",
"email": "<email>"
}'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?