Replaces the calling person's password.
Replaces the calling person's password. Only their own — there is no shape of this request that writes somebody else's.
PUT /v1/iam/password
| Address | https://api.hanzo.ai/v1/iam/password |
| Method | PUT |
| Operation | put_iam_password |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Replaces the calling person's password. Only their own — there is no shape of this request that writes somebody else's.
Prove who you are with the password you are replacing, or — when you cannot sign in at all — with a code sent to the address the account already holds. Exactly one of the two: a request carrying both proves nothing more than either, and answering it would mean deciding which one mattered.
A reset also clears the account lockout, in the SAME transaction as the digest. Replacing a credential retires the run of guesses against the old one, and without this a person who reset a forgotten password was still refused for up to fifteen more minutes — with the brand-new password they had just chosen.
Request
7 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
Cookie | header | string | — | |
Authorization | header | string | — | |
code | body | string | — | Code is the one-time code delivered to the account's own address. |
oldPassword | body | string | — | OldPassword is the credential being replaced, the proof a signed-in caller gives instead of a code. |
organization | body | string | — | The account being recovered, for a caller who cannot be signed in. |
password | body | string | — | Password is the new credential. |
username | body | string | — | email, username OR phone |
Response
| Status | Body | Meaning |
|---|---|---|
200 | iam.Answer | ok |
400 | iam.Answer | bad request |
200 body — 8 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
code | body | string | — | |
data | body | object | — | |
data2 | body | object | — | |
data3 | body | object | — | |
msg | body | string | — | |
name | body | string | — | |
status | body | string | — | |
sub | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo iam passwordimport { Configuration, IamApi } from 'hanzoai';
const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putIamPassword({ code: "<code>", oldPassword: "<oldPassword>" });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).put_iam_password(code="<code>", old_password="<oldPassword>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IamAPI.PutIamPassword(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::put_iam_password(&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).putIamPassword();curl -X PUT https://api.hanzo.ai/v1/iam/password \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"code": "<code>",
"oldPassword": "<oldPassword>"
}'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?