privy apps config update
Update application configuration and verify changed fields by reading them back.
privy apps config update [options]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> |
Application display name. |
--allowed-domains <json> |
Allowed domains. Replaces the complete array; does not append. |
--email-auth <boolean> |
Enable email login. |
--disable-plus-emails <boolean> |
Reject plus-addressed app-user email identities; does not change dashboard email login. |
--block-temporary-email-domains <boolean> |
Block temporary/disposable email domains for app users. |
--wallet-auth <boolean> |
Enable external Ethereum-wallet login. Does not request or perform a signature. |
--solana-wallet-auth <boolean> |
Enable external Solana-wallet login. Does not request or perform a signature. |
--external-wallets-for-signup-enabled <boolean> |
Allow external-wallet signup rather than linking only; does not create users or wallets. |
--max-linked-wallets-per-user <integer> |
Dashboard choices: restrict to one external wallet, or allow the default twenty. |
--show-wallet-login-first <boolean> |
Prioritize web3 wallet methods instead of email/SMS/social methods in the app login UI. |
--passkeys-for-signup-enabled <boolean> |
Allow passkey-only signup; requires passkey_auth. Losing all passkeys without another login method can lose account access. |
--google-oauth <boolean> |
Enable Google login; provider configuration may also be required. |
--github-oauth <boolean> |
Enable GitHub login; provider configuration may also be required. |
--discord-oauth <boolean> |
Enable Discord login; own credentials are optional. |
--apple-oauth <boolean> |
Enable apple OAuth login. Own provider credentials are optional; migration rules remain server-enforced. |
--twitter-oauth <boolean> |
Enable twitter OAuth login. Own provider credentials are optional; migration rules remain server-enforced. |
--linkedin-oauth <boolean> |
Enable linkedin OAuth login. Own provider credentials are optional; migration rules remain server-enforced. |
--tiktok-oauth <boolean> |
Enable tiktok OAuth login. Own provider credentials are optional; migration rules remain server-enforced. |
--line-oauth <boolean> |
Enable line OAuth login. Own provider credentials are optional; migration rules remain server-enforced. |
--twitch-oauth <boolean> |
Enable twitch OAuth login. Own provider credentials are optional; migration rules remain server-enforced. |
--spotify-oauth <boolean> |
Enable spotify OAuth login. Requires own provider configuration. |
--instagram-oauth <boolean> |
Enable instagram OAuth login. Requires own provider configuration. |
--telegram-oauth <boolean> |
Enable telegram OAuth login. Requires own provider configuration. |
--telegram-auth <boolean> |
Enable bot-based Telegram authentication; distinct from telegram_oauth. Requires app bot configuration. |
--farcaster-auth <boolean> |
Enable Sign in with Farcaster. |
--farcaster-link-wallets-enabled <boolean> |
Link Farcaster connected wallets; requires external Ethereum wallet login. |
--passkey-auth <boolean> |
Enable passkey login. |
--accent-color <string> |
Brand color in #RGB or #RRGGBB format. |
--logo-url <string> |
HTTP(S) JPEG/JPG/GIF/PNG logo URL, or null to clear. No embedded credentials or SVG. File upload is separate. |
--terms-and-conditions-url <string> |
HTTPS terms link, or null to clear. |
--privacy-policy-url <string> |
HTTPS privacy-policy link, or null to clear. |
--require-users-accept-terms <boolean> |
Require explicit app-user consent during login. Requires at least one configured legal link; does not change dashboard authentication. |
--patch <json> |
Compatibility alias for --body. |
--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”privy apps config update --name demo --dry-runprivy apps config update --file patch.json --diffprivy apps config update --body - --yes < patch.jsonBehavior
Section titled “Behavior”- Changes data: yes. Preview with
--dry-run, then run with--yesand any required confirmations. - Scope: app
- Before it runs: GET app configuration.
- Production apps: Requires
--allow-productionin addition to--yes. - Verification: GET app configuration and compare changed fields.
Related guides
Section titled “Related guides”Inspect the full contract locally with privy schema apps config 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.