schemas/config/auth

Type Aliases

'Read the “', Type Aliases, '” section'

AuthProviders

'Read the “', AuthProviders, '” section'

type AuthProviders = {
  auth0: boolean;
  discord: boolean;
  github: boolean;
  google: boolean;
  usernameAndPassword: boolean;
  usernameAndPasswordConfig: {
     allowUserRegistration: boolean;
    };
};

Defined in: studiocms/packages/studiocms/src/schemas/config/auth.ts:62

Type declaration

'Read the “', Type declaration, '” section'

auth0

'Read the “', auth0, '” section'

auth0: boolean;

Auth0 Auth Provider - Powered by Arctic

Requires an Auth0 Application to be created and configured using ENV Variables

Default

'Read the “', Default, '” section'

false

discord

'Read the “', discord, '” section'

discord: boolean;

Discord Auth Provider - Powered by Arctic

Requires a Discord OAuth App to be created and configured using ENV Variables

Default

'Read the “', Default, '” section'

false

github

'Read the “', github, '” section'

github: boolean;

GitHub Auth Provider - Powered by Arctic

Requires a GitHub OAuth App to be created and configured using ENV Variables

Default

'Read the “', Default, '” section'

false

google

'Read the “', google, '” section'

google: boolean;

Google Auth Provider - Powered by Arctic

Requires a Google OAuth App to be created and configured using ENV Variables

Default

'Read the “', Default, '” section'

false

usernameAndPassword

'Read the “', usernameAndPassword, '” section'

usernameAndPassword: boolean;

Username and Password Auth Provider

usernameAndPasswordConfig

'Read the “', usernameAndPasswordConfig, '” section'

usernameAndPasswordConfig: {
  allowUserRegistration: boolean;
 } = localUsernameAndPasswordConfig;

usernameAndPasswordConfig.allowUserRegistration

'Read the “', usernameAndPasswordConfig.allowUserRegistration, '” section'

allowUserRegistration: boolean;

Allow User Registration - Allows users to register an account

Default

'Read the “', Default, '” section'

false

Variables

'Read the “', Variables, '” section'

authConfigSchema

'Read the “', authConfigSchema, '” section'

const authConfigSchema: ZodDefault<ZodOptional<ZodObject<{
  enabled: ZodDefault<ZodOptional<ZodBoolean>>;
  providers: ZodDefault<ZodOptional<ZodObject<{
     auth0: ZodDefault<ZodOptional<ZodBoolean>>;
     discord: ZodDefault<ZodOptional<ZodBoolean>>;
     github: ZodDefault<ZodOptional<ZodBoolean>>;
     google: ZodDefault<ZodOptional<ZodBoolean>>;
     usernameAndPassword: ZodDefault<ZodOptional<ZodBoolean>>;
     usernameAndPasswordConfig: ZodDefault<ZodOptional<ZodObject<..., ..., ..., ..., ...>>>;
    }, "strip", ZodTypeAny, {
     auth0: boolean;
     discord: boolean;
     github: boolean;
     google: boolean;
     usernameAndPassword: boolean;
     usernameAndPasswordConfig: {
        allowUserRegistration: boolean;
       };
    }, {
     auth0: boolean;
     discord: boolean;
     github: boolean;
     google: boolean;
     usernameAndPassword: boolean;
     usernameAndPasswordConfig: {
        allowUserRegistration: ... | ... | ...;
       };
    }>>>;
 }, "strip", ZodTypeAny, {
  enabled: boolean;
  providers: {
     auth0: boolean;
     discord: boolean;
     github: boolean;
     google: boolean;
     usernameAndPassword: boolean;
     usernameAndPasswordConfig: {
        allowUserRegistration: boolean;
       };
    };
 }, {
  enabled: boolean;
  providers: {
     auth0: boolean;
     discord: boolean;
     github: boolean;
     google: boolean;
     usernameAndPassword: boolean;
     usernameAndPasswordConfig: {
        allowUserRegistration: boolean;
       };
    };
}>>>;

Defined in: studiocms/packages/studiocms/src/schemas/config/auth.ts:67

---

authProviderSchema

'Read the “', authProviderSchema, '” section'

const authProviderSchema: ZodDefault<AuthProviders>;

Defined in: studiocms/packages/studiocms/src/schemas/config/auth.ts:18