update-user

Update non-activity user fields

Auth

Self

Example

pearing-cli update-user self --name "Alice Doe"

Expected Response

Updates the resource and prints the updated JSON object. Use update-user-activity for activity changes.

Errors

  • 400 Bad Request for invalid flags/values.
  • 403 Forbidden when caller targets another user or requests a disallowed update.
  • 404 Not Found when referenced owners/resources are missing.
  • 409 Conflict for uniqueness or state conflicts.

Common auth errors are documented on the CLI overview page.

Help Output

Update a user.

Updates fields on an existing user. Only provided fields are changed.
The target must be the authenticated user.

Example:

  update-user alice --name "Alice Johnson" --email alice-new@example.com
  update-user self --name "Alice Johnson"

Usage: pearing-cli update-user [OPTIONS] <TARGET_USERNAME>

Arguments:
  <TARGET_USERNAME>
          Existing username to update

Options:
      --username <USERNAME>
          Username

      --name <NAME>
          User name

      --email <EMAIL>
          User email

      --staff <STAFF>
          Whether the user is staff
          
          [possible values: true, false]

  -h, --help
          Print help (see a summary with '-h')