Docs

zitadel auth-method sso enable

Add an identity provider to a user schema.

Usage

npx @zitadel/cli@latest auth-method sso enable [flags]

Flags

FlagDescription
--provider <value>Identity provider to enable, or "custom" for a custom OpenID Connect (OIDC) provider. One of google, custom.
--slug <value>Name of the custom connection. Schemas and flows refer to it by this.
--display-name <value>Name shown on the custom connection's sign-in button.
--issuer <value>Issuer URL of the custom provider. Its endpoints are found by OIDC discovery.
--scopes <value>Scopes the custom connection requests, separated by spaces or commas. Must include openid. Default: openid profile email.
--client-id <value>Client id of the application registered with the provider.
-e, --env <value>Environment to run against, e.g. production. Defaults to ZITADEL_ENV, then the hosting platform's build (VERCEL_ENV, or Netlify's CONTEXT), then development.
--env-file <value>Read ZITADEL_* values from this file ahead of the process environment. A relative path is read from the current directory, not from --cwd. Cannot be combined with --env.
--schema <value>User schema to change. Required when the Project has more than one.

It also takes the global flags.

Examples

npx @zitadel/cli@latest auth-method sso enable --provider google
npx @zitadel/cli@latest auth-method sso enable --provider google --schema customers
npx @zitadel/cli@latest auth-method sso enable --provider google --client-id 1234-abc.apps.googleusercontent.com --non-interactive < secret.txt
npx @zitadel/cli@latest auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example
npx @zitadel/cli@latest auth-method sso enable --provider custom --slug acme-sso --display-name 'Acme SSO' --issuer https://sso.acme.example --scopes 'openid profile email groups' --client-id abc123 --non-interactive < secret.txt

Was this helpful?

On this page