Auth

Config

Return public auth configuration (no authentication required).

get/auth/config/

Request

  • The document declares no server URL.
  • Auth: none declared

Response

Successful Response

registration_enabledboolean required

Whether self-service registration is open. Single sign-on can create accounts whenever this is true.

allow_signupboolean

Whether password sign-up is open: registration is enabled and password login is enabled. Login UI uses this to show/hide the signup link.

email_verification_requiredboolean

When true, new self-registered users must verify their email before logging in. Default false for back-compat-safe parsing by older clients.

auth_methodsstring[]

Auth methods contributed by the active AuthExtension. Empty by default; compatible deployments may add methods such as ['saml']. Login UI can render conditional sign-in options without needing admin OAuthProvider access.

landing_firstboolean

When true, unauthenticated visits to '/' are redirected to '/login' as the product landing page. Default false (search catalog is the root).

banner_enabledboolean

When true and banner_text is non-empty, the site-wide announcement banner is shown. Default false.

banner_textstring

Admin-configured site-wide announcement banner text. Empty string means no banner is shown.

banner_colorstring

Theme token for the site banner color: warning | info | success | destructive.

password_login_enabledboolean

When false, password login is disabled for users without manage_settings. Default true for back-compat-safe parsing by older clients.

Changes

No recorded changes to this operation across all 50 revisions of this API.