update-user

Update a user

Auth

Staff Self

Example

ghit-cli update-user alice --name "Alice Doe"

Expected Response

Updates the resource and prints the updated JSON object.

Errors

  • 400 Bad Request for invalid flags/values.
  • 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

Usage: ghit-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