LoginDefinition

MPO Version: 1.3.0

Defines the core login architecture of the project, including the user and tenant structures that underpin authentication and access. These settings enable Mindbricks to generate a built-in 'auth' service tailored to your data model, supporting user registration, login, permissions, and optional multi-tenant behavior.

interface LoginDefinition = {
  userSettings : LoginDefUserSettings;
  tenantSettings : LoginDefTenantSettings;
}

LoginDefUserSettings

MPO Version: 1.3.0

Defines how users are stored, managed, and authenticated within the project. This includes the primary login identifier configuration (email, mobile, or dual), secondary identifier presence rules, super admin credentials, email and mobile verification settings, public registration policies, and whether user groups are active. This structure governs the behavior and structure of the user service's primary data model.

interface LoginDefUserSettings = {
  primaryLoginIdentifier : PrimaryLoginIdentifier;
  superAdminIdentifier : String;
  superAdminPassword : String;
  userNameType : UserNameType;
  superAdminData : DataMapItem[];
  userGroupsActive : Boolean;
  userGroupsInTenantLevel : Boolean;
  secondaryIdentifierPresence : SecondaryIdentifierPresence;
  dualIdentifierRegistration : DualIdentifierRegistration;
  emailVerificationRequiredForLogin : Boolean;
  mobileVerificationRequiredForLogin : Boolean;
  mobile2FARequiredForLogin : Boolean;
  email2FARequiredForLogin : Boolean;
  userRegisterIsPublic : Boolean;
  userAutoAvatarScript : MScript;
  userGroupAutoAvatarScript : MScript;
}

PrimaryLoginIdentifier

Specifies which field is used as the primary login identifier for user accounts.

const PrimaryLoginIdentifier = {
  email: "email",
  mobile: "mobile",
  emailOrMobile: "emailOrMobile",
};

SecondaryIdentifierPresence

Controls the presence and requirement level of the non-primary identifier field in the user data model.

const SecondaryIdentifierPresence = {
  none: "none",
  optional: "optional",
  required: "required",
};

DualIdentifierRegistration

Controls registration behavior when primaryLoginIdentifier is 'emailOrMobile'. Ignored for other values.

const DualIdentifierRegistration = {
  atLeastOne: "atLeastOne",
  both: "both",
};

UserNameType

Specifies how user names are represented in the data model.

const UserNameType = {
  asFullname: "asFullname",
  asNamePair: "asNamePair",
};

LoginDefTenantSettings

MPO Version: 1.3.0

Specifies how tenant-based access control is structured for multi-tenant projects. This includes the tenant object name, registration permissions, and tenant separation logic. When enabled, this enforces strict data and user isolation by tenant.

interface LoginDefTenantSettings = {
  useMultiTenantFeature : Boolean;
  configuration : LoginDefTenantSettingsConfig;
}

LoginDefTenantSettingsConfig

MPO Version: 1.3.0

Configuration details for tenant-based access control, including tenant registration, naming, and avatar script.

interface LoginDefTenantSettingsConfig = {
  tenantRegisterIsPublic : Boolean;
  tenantName : String;
  tenantAutoAvatarScript : MScript;
}