schemas/config/auth

Type Aliases

AuthProviders

type AuthProviders = {
  usernameAndPassword: boolean;
  usernameAndPasswordConfig: {
     allowUserRegistration: boolean;
  };
};

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

Type Declaration

usernameAndPassword

usernameAndPassword: boolean;

Username and Password Auth Provider

usernameAndPasswordConfig

usernameAndPasswordConfig: {
  allowUserRegistration: boolean;
} = localUsernameAndPasswordConfig;

usernameAndPasswordConfig.allowUserRegistration

allowUserRegistration: boolean;

Allow User Registration - Allows users to register an account

Default

false

Variables

authConfigSchema

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

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

---

authProviderSchema

const authProviderSchema: ZodDefault<AuthProviders>;

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

---

localUsernameAndPasswordConfig

const localUsernameAndPasswordConfig: ZodDefault<ZodOptional<ZodObject<{
  allowUserRegistration: ZodDefault<ZodOptional<ZodBoolean>>;
}, "strip", ZodTypeAny, {
  allowUserRegistration: boolean;
}, {
  allowUserRegistration?: boolean;
}>>>;

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