Set a password​
Add, update or reset a user's password with either a verification code or the current password.
Path Parameters
unique identifier of the user.
Request Body required
newPassword object
Provide the new password (in plain text or as hash).
Possible values: non-empty
and <= 200 characters
Provide the plain text password. ZITADEL will take care to store it in a secure way (hash).
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.
Provide if the user needs to change the password on the next use.
Possible values: non-empty
and <= 200 characters
Provide the current password to verify you're allowed to change the password.
Possible values: non-empty
and <= 20 characters
Or provider the verification code generated during password reset request.
Request Body required
newPassword object
Provide the new password (in plain text or as hash).
Possible values: non-empty
and <= 200 characters
Provide the plain text password. ZITADEL will take care to store it in a secure way (hash).
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.
Provide if the user needs to change the password on the next use.
Possible values: non-empty
and <= 200 characters
Provide the current password to verify you're allowed to change the password.
Possible values: non-empty
and <= 20 characters
Or provider the verification code generated during password reset request.
Request Body required
newPassword object
Provide the new password (in plain text or as hash).
Possible values: non-empty
and <= 200 characters
Provide the plain text password. ZITADEL will take care to store it in a secure way (hash).
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.
Provide if the user needs to change the password on the next use.
Possible values: non-empty
and <= 200 characters
Provide the current password to verify you're allowed to change the password.
Possible values: non-empty
and <= 20 characters
Or provider the verification code generated during password reset request.
- 200
- 403
- 404
- default
Password successfully set
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.384Z",
"resourceOwner": "69629023906488334"
}
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.385Z",
"resourceOwner": "69629023906488334"
}
}
Schema
details object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
{
"details": {
"sequence": "2",
"changeDate": "2024-06-13T06:44:36.385Z",
"resourceOwner": "69629023906488334"
}
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}