Hanzo
OpenapiIam

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

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
codebodystringCode is the one-time code delivered to the account's own address.
oldPasswordbodystringOldPassword is the credential being replaced, the proof a signed-in caller gives instead of a code.
organizationbodystringThe account being recovered, for a caller who cannot be signed in.
passwordbodystringPassword is the new credential.
usernamebodystringemail, username OR phone

Response

StatusBodyMeaning
200iam.Answerok
400iam.Answerbad request

200 body — 8 fields.

FieldInTypeAlwaysDescription
codebodystring
databodyobject
data2bodyobject
data3bodyobject
msgbodystring
namebodystring
statusbodystring
subbodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo iam password

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page