Logto API references

Update user

PATCH /api/users/{userId}

Update user data for the given ID. This method performs a partial update.

Path parameters

userId string Required

The unique identifier of the user.

application/json

Body Required

username string(regex) | null | string(empty)

One of:
string-1 string(regex) | null string-2 string(empty) | null

Updated username for the user. It should be unique across all users.

Format should match the following pattern: /^[A-Z_a-z]\w*$/.

Updated username for the user. It should be unique across all users.
primaryEmail string(regex) | null | string(empty)

One of:
string-1 string(regex) | null string-2 string(empty) | null

Updated primary email address for the user. It should be unique across all users.

Format should match the following pattern: /^\S+@\S+\.\S+$/.

Updated primary email address for the user. It should be unique across all users.
primaryPhone string(regex) | null | string(empty)

One of:
string-1 string(regex) | null string-2 string(empty) | null

Updated primary phone number for the user. It should be unique across all users.

Format should match the following pattern: /^\d+$/.

Updated primary phone number for the user. It should be unique across all users.
name string | null | string(empty)

One of:
string-1 string | null string-2 string(empty) | null
avatar string(url) | null | string(empty)

One of:
string-1 string(url) | null string-2 string(empty) | null
customData object

Custom data object to update for the given user ID. Note this will replace the entire custom data object.

If you want to perform a partial update, use the PATCH /api/users/{userId}/custom-data endpoint instead.
profile object
Hide profile attributes Show profile attributes
- familyName string
- givenName string
- middleName string
- nickname string
- preferredUsername string
- profile string
- website string
- gender string
- birthdate string
- zoneinfo string
- locale string
- address object
  Hide address attributes Show address attributes
  
  formatted string
  
  streetAddress string
  
  locality string
  
  region string
  
  postalCode string
  
  country string

Responses

• 200 application/json

Updated user data for the given ID.
Hide response attributes Show response attributes object
- id string Required
  
  Minimum length is 1, maximum length is 12.
- username string | null Required
  
  Maximum length is 128.
- primaryEmail string | null Required
  
  Maximum length is 128.
- primaryPhone string | null Required
  
  Maximum length is 128.
- name string | null Required
  
  Maximum length is 128.
- avatar string | null Required
  
  Maximum length is 2048.
- customData object Required
  
  arbitrary
- identities object Required
  
  Hide identities attributes Show identities attributes
  
  Additional properties
  
  userId string
  
  details object
  
  arbitrary
- lastSignInAt number | null Required
- createdAt number Required
- updatedAt number Required
- profile object Required
  
  Hide profile attributes Show profile attributes
  
  familyName string
  
  givenName string
  
  middleName string
  
  nickname string
  
  preferredUsername string
  
  profile string
  
  website string
  
  gender string
  
  birthdate string
  
  zoneinfo string
  
  locale string
  
  address object
  
  Hide address attributes Show address attributes
  
  formatted string
  
  streetAddress string
  
  locality string
  
  region string
  
  postalCode string
  
  country string
- applicationId string | null Required
  
  Maximum length is 21.
- isSuspended boolean Required
- hasPassword boolean
- ssoIdentities array[object]
  
  Hide ssoIdentities attributes Show ssoIdentities attributes object
  
  id string Required
  
  Minimum length is 1, maximum length is 21.
  
  userId string Required
  
  Minimum length is 1, maximum length is 12.
  
  issuer string Required
  
  Minimum length is 1, maximum length is 256.
  
  identityId string Required
  
  Minimum length is 1, maximum length is 128.
  
  detail object Required
  
  arbitrary
  
  createdAt number Required
  
  ssoConnectorId string Required
  
  Minimum length is 1, maximum length is 128.
• 400

Bad Request
• 401

Unauthorized
• 403

Forbidden
• 404

Not Found
• 422

Unprocessable Content

PATCH /api/users/{userId}

curl \
 -X PATCH https://[tenant_id].logto.app/api/users/{userId} \
 -H "Content-Type: application/json" \
 -d '{"username":"string","primaryEmail":"string","primaryPhone":"string","name":"string","avatar":"string","customData":{},"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"}}}'

Request example

{
  "username": "string",
  "primaryEmail": "string",
  "primaryPhone": "string",
  "name": "string",
  "avatar": "string",
  "customData": {},
  "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"
    }
  }
}

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"
    }
  ]
}