privy providers custom create
Create an enabled, immutable custom OAuth provider; deletion may become unavailable after signup.
privy providers custom create [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. |
--provider <string> |
Immutable custom provider ID, custom:<lowercase-slug>. |
--provider-display-name <string> |
Display name used in the login UI. |
--provider-icon-url <string> |
HTTPS provider icon URL. |
--client-id <string> |
Provider client ID. Configure together with client_secret. |
--authorization-url <string> |
HTTPS authorization URL. |
--token-url <string> |
HTTPS token URL. |
--jwks-url <string> |
HTTPS JWKS URL. |
--scopes <json> |
Explicit nonempty scope array. For OIDC id_token providers include the required openid scope. |
--scopes-delimiter <string> |
Space delimiter used by the dashboard custom-provider form. |
--pkce-enabled <boolean> |
Use PKCE. Defaults on. |
--user-info-source <string> |
Source from which the provider user profile is extracted. |
--profile-url <string> |
HTTPS profile URL, required for profile_endpoint. |
--path-to-name <string> |
Profile name extraction path. |
--path-to-username <string> |
Username extraction path. |
--path-to-email <string> |
Email extraction path. |
--path-to-profile-picture-url <string> |
Picture extraction path. |
--return-oauth-tokens <boolean> |
Return provider tokens to the app after user authorization; does not fetch tokens now. |
--use-cookie-domain-for-oauth-redirect <boolean> |
False, matching the observed dashboard custom-provider creation contract. |
--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 providers custom create --body - --yes < /dev/stdinBehavior
Section titled “Behavior”- Changes data: yes. Preview with
--dry-run, then run with--yesand any required confirmations. - Scope: app
- Before it runs: Selected app/environment and current configuration; editability/feature/provider-specific guards.
- Production apps: Requires
--allow-productionand--yes. - Verification: Fresh public configuration; masked or omitted secret values and real external login are not verified.
- Retries: None.
Related guides
Section titled “Related guides”Inspect the full contract locally with privy schema providers custom create.
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.