Skip to main content

Set a password

POST 
/resources/v3alpha/users/:id/password

Add, update or reset a user's password with either a verification code or the current password.

Request​

Path Parameters

    id stringrequired

    unique identifier of the user.

Query Parameters

    instance.id string
    instance.domain string
    organization.orgId string
    organization.orgDomain string

Body

required

Provide the new password (in plain text or as hash).

    password stringrequired

    Possible values: non-empty and <= 200 characters

    Provide the plain text password. ZITADEL will take care to store it in a secure way (hash).

    hash stringrequired

    Possible values: non-empty and <= 200 characters

    Encoded hash of a password in Modular Crypt Format: https://zitadel.com/docs/concepts/architecture/secrets#hashed-secrets.

    changeRequired boolean

    Provide if the user needs to change the password on the next use.

    currentPassword stringrequired

    Possible values: non-empty and <= 200 characters

    Provide the current password to verify you're allowed to change the password.

    verificationCode stringrequired

    Possible values: non-empty and <= 20 characters

    Or provider the verification code generated during password reset request.

Responses​

Password successfully set

Schema

    details

    object

    id string
    created date-time

    the timestamp of the first event applied to the object.

    changed date-time

    the timestamp of the last event applied to the object.

    owner

    object

    the parent object representing the returned objects context.

    type string

    Possible values: [OWNER_TYPE_UNSPECIFIED, OWNER_TYPE_SYSTEM, OWNER_TYPE_INSTANCE, OWNER_TYPE_ORG]

    Default value: OWNER_TYPE_UNSPECIFIED

    id string
Loading...