Change password

Change the password of a user with either a verification code or the current password.

Path Parameters

userId string required

application/json

application/grpc

application/grpc-web+proto

Request Body required

newPassword object
password string required
Possible values: non-empty and <= 200 characters
changeRequired boolean
currentPassword string required

Possible values: non-empty and <= 200 characters

verificationCode string required

Possible values: non-empty and <= 20 characters

"the verification code generated during password reset request"

Request Body required

newPassword object
password string required
Possible values: non-empty and <= 200 characters
changeRequired boolean
currentPassword string required

Possible values: non-empty and <= 200 characters

verificationCode string required

Possible values: non-empty and <= 20 characters

"the verification code generated during password reset request"

Request Body required

newPassword object
password string required
Possible values: non-empty and <= 200 characters
changeRequired boolean
currentPassword string required

Possible values: non-empty and <= 200 characters

verificationCode string required

Possible values: non-empty and <= 20 characters

"the verification code generated during password reset request"

Responses

• 200
• 403
• 404
• default

---

OK

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-04-09T11:59:28.518Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-04-09T11:59:28.518Z",
    "resourceOwner": "69629023906488334"
  }
}

Schema

Example (from schema)

---

Schema

details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
resourceOwner resource_owner is the organization or instance_id an object belongs to

{
  "details": {
    "sequence": "2",
    "changeDate": "2024-04-09T11:59:28.519Z",
    "resourceOwner": "69629023906488334"
  }
}

Returned when the user does not have permission to access the resource.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

POST /v2beta/users/:userId/password

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN

Bearer Token

userId — path required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/password' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "newPassword": {
    "password": "Secr3tP4ssw0rd!",
    "changeRequired": true
  },
  "currentPassword": "Secr3tP4ssw0rd!",
  "verificationCode": "SKJd342k"
}'