Skip to content
CLIUnofficial

privy users update

Update or clear a user display name and verify it.

Usage

Section titled “Usage”
Terminal window
privy users update [options] <user-id>

Arguments

Section titled “Arguments”
Argument Description
user-id —

Options

Section titled “Options”
Option Description
--dry-run Validate and print the API request without network access or credentials.
--yes Confirm this mutation or export.
--body <json> JSON body, or - to read stdin.
--file <path> JSON body file, or - to read stdin.
--display-name <string> Display name; JSON null clears it. Does not change linked accounts.
--diff Read live state and show changes WITHOUT writing (requires login).
--allow-production Explicitly allow this production mutation; also requires --yes.

Global options such as --app, --account and --profile also apply. See the command reference overview.

Examples

Section titled “Examples”
Terminal window
privy users update <user-id> --display-name Alice --diff
privy users update <user-id> --display-name Alice --yes

Behavior

Section titled “Behavior”
  • Changes data: yes. Preview with --dry-run, then run with --yes and any required confirmations.
  • Scope: app
  • Before it runs: Read app environment; existing users are looked up by exact ID before mutations.
  • Production apps: Requires --allow-production and --yes.
  • Verification: Read-back where observable; bulk jobs are submissions, not completed imports. Revocation reports observed state without claiming an end-user session exercise.
  • Retries: None.
Section titled “Related guides”

Inspect the full contract locally with privy schema users update.

Privy CLI is an unofficial, community project by Samarth Saxena. Not affiliated with or endorsed by Privy. The Privy name and wordmark belong to Privy. It uses undocumented dashboard APIs that can change.