Update user password

PATCH /api/users/{userId}/password

Update user password for the given ID.

Path parameters

  • userId string Required

    The unique identifier of the user.


Body Required

  • password string Required

    New password for the user.

    Minimum length is 1.


PATCH /api/users/{userId}/password
curl \
 -X PATCH https://[tenant_id].logto.app/api/users/{userId}/password \
 -H "Content-Type: application/json" \
 -d '{"password":"string"}'
Request examples
  "password": "string"
Response examples (200)
  "id": "string",
  "username": "string",
  "primaryEmail": "string",
  "primaryPhone": "string",
  "name": "string",
  "avatar": "string",
  "customData": {},
  "identities": {
    "userId": "string",
    "details": {}
  "lastSignInAt": 42.0,
  "createdAt": 42.0,
  "updatedAt": 42.0,
  "profile": {
    "familyName": "string",
    "givenName": "string",
    "middleName": "string",
    "nickname": "string",
    "preferredUsername": "string",
    "profile": "string",
    "website": "string",
    "gender": "string",
    "birthdate": "string",
    "zoneinfo": "string",
    "locale": "string",
    "address": {
      "formatted": "string",
      "streetAddress": "string",
      "locality": "string",
      "region": "string",
      "postalCode": "string",
      "country": "string"
  "applicationId": "string",
  "isSuspended": true,
  "hasPassword": true,
  "ssoIdentities": [
      "id": "string",
      "userId": "string",
      "issuer": "string",
      "identityId": "string",
      "detail": {},
      "createdAt": 42.0,
      "ssoConnectorId": "string"