Update user username

Updates a user's username. Users must provide a current password when updating their own username (unless they are SSO users with oidcIgnoreUsername enabled). Admins can update any user's username without the current password.

patch/users/{id}/username

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/users/{id}/username
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Path parameters

idstring required

Example:1357158568008091264

ID of the user whose username to update

Request body

usernamestring nullable

Unique username for user identification

currentPasswordstring

Current password (required when updating own username)

Example request

{
  "username": "john_doe",
  "currentPassword": "SecurePassword123!"
}

Response

Username updated successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "email": "john.doe@example.com",
    "role": "admin",
    "name": "John Doe",
    "username": "john_doe",
    "avatar": {
      "url": "https://storage.example.com/user-avatars/1357158568008091264/original.jpg",
      "thumbnailUrls": {
        "cover180": "https://storage.example.com/user-avatars/1357158568008091264/cover-180.jpg"
      }
    },
    "gravatarUrl": "https://www.gravatar.com/avatar/abc123",
    "phone": "+1234567890",
    "organization": "Acme Corporation",
    "language": "en-US",
    "apiKeyPrefix": "D89VszVs",
    "subscribeToCardWhenCommenting": true,
    "enableFavoritesByDefault": true,
    "defaultEditorMode": "wysiwyg",
    "defaultHomeView": "groupedProjects",
    "defaultProjectsOrder": "byDefault",
    "lockedFieldNames": [
      "email",
      "password",
      "name"
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.