Replace password

Replaces the calling person's password.

PUT /v1/iam/password

Addresshttps://api.hanzo.ai/v1/iam/password
MethodPUT
Operationput_iam_password
AuthAuthorization: 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).

FieldInTypeRequiredDescription
Cookieheaderstring—
Authorizationheaderstring—
codebodystring—Code is the one-time code delivered to the account's own address.
oldPasswordbodystring—OldPassword is the credential being replaced, the proof a signed-in caller gives instead of a code.
organizationbodystring—The account being recovered, for a caller who cannot be signed in.
passwordbodystring—Password is the new credential.
usernamebodystring—email, username OR phone

Response

StatusBodyMeaning
200iam.Answerok
400iam.Answerbad request
defaultproblem-detailsrefused

200 body — 8 fields.

FieldInTypeAlwaysDescription
codebodystring—
databodyany—
data2bodyany—
data3bodyany—
msgbodystring—
namebodystring—
statusbodystring—
subbodystring—

Failure carries the platform error shape — see Errors.

Examples

hanzo iam password
import { 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 := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.IamAPI.PutIamPassword(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::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.setBearerToken(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>"
     }'

MCP reaches iam through the iam tool, which names its 44 operations with its own verbs — this one among them, under a name only MCP 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_iam_applications"
         }
       }
     }'

IAM API · All Hanzo APIs · Interactive reference

Was this page useful?