Skip to content
CLIUnofficial

privy clients update

Update client origins, identity and app-user session settings; supports read-only diff.

Usage

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

Arguments

Section titled “Arguments”
Argument Description
client-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.
--name <string> Internal client name.
--display-name <string> User-facing login-message name. Domains/URLs and control characters are not valid names; Privy validates content.
--client-type <string> Client frontend environment.
--allowed-domains <json> Complete allowed-origin array; backend validates wildcard/origin syntax. [] removes restrictions in permitted environments.
--allowed-native-app-ids <json> Complete mobile app-identifier array, e.g. io.example.privycli.
--allowed-native-app-url-schemes <json> Complete mobile URL-scheme array.
--use-app-cookie-domain-settings <boolean> Web-only inheritance of configured app cookie domain. Setting false requires separate client cookie setup.
--session-timeout-minutes <integer> App-user session duration: 1–400 days, in minutes. Does not modify dashboard login.
--session-inactivity-window-minutes <integer> App-user session inactivity duration: 1–400 days, in minutes.
--access-token-lifetime-minutes <integer> App-user access-token lifetime: 10 minutes–24 hours. Public configuration, not a token.
--id-token-lifetime-minutes <integer> App-user identity-token lifetime: 10 minutes–24 hours. Public configuration, not a token.
--apple-oauth-client-id-override <string> Apple OAuth client-ID override; provider configuration is separate.
--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 clients update <client-id> --name renamed-client --diff
privy clients update <client-id> --allowed-domains '["https://example.invalid"]' --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: Check app environment and same-app client; cookie inheritance requires a configured app domain.
  • Production apps: Requires --allow-production and --yes.
  • Verification: Fresh exact-ID list comparison.
  • Retries: None.
Section titled “Related guides”

Inspect the full contract locally with privy schema clients 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.