Settings
Membership module settings
Last updated
Membership module settings
Last updated
The "Settings" page in the CodeMash Membership module is a central location where you can configure various aspects of the module's behavior and features. For example, this page allows you to set the default role for newly registered users, specify the required information for user registration, and configure the module's security settings.
The registration section is responsible for setting the rules and settings for user registration in the app. In this section, you can define which roles can be assigned to users during registration and any other settings or rules related to the registration process.
The "Invitation" settings section allows you to invite users to your website or app and register them as new users. This feature can be helpful if you want to provide access to your website or app to a specific group of users, such as employees, customers, or partners.
The Verification section allows you to specify whether or not newly registered users should verify their email addresses. This feature can be helpful if you want to ensure that only users with valid email addresses can access your website or app.
The "Deactivation" section allows you to specify how users can deactivate or delete their accounts on your website or app. This feature can help manage user privacy and ensure users have control over their personal information. Users can typically access their account settings or profile page and follow the instructions to deactivate or delete their accounts. This may involve entering a password or confirmation code to complete the deactivation process.
The "User meta fields template" field in the CodeMash Membership module allows you to extend the standard user fields in your database schema and create custom fields specific to your app's requirements. This feature can be helpful if you need to store additional information about your users that is not covered by the standard user fields provided by CodeMash.
To use the "User meta fields template" field, you must specify the custom fields you want to create. These fields can be simple format fields such as text, numbers, or dates or more complex fields such as arrays or objects.
Once you have specified your custom fields, they will be added to the user schema and available in the Membership module. This will allow you to store and manage additional user information as needed.
It's important to note that not all fields in the database schema creation process will be available in the Membership module settings. Suppose you need to create complex scenarios or store a large amount of data about your users. In that case, creating a separate collection called "User profile" may be more appropriate and linking it to the Membership module rather than using the "User meta fields template" field.
User registers as
The "User registers as" field allows you to specify the role that will be applied to a newly registered user. This field is typically used in conjunction with role-based access controls, which allow you to grant different levels of access to different users based on their roles.
Allowed roles to register as
The "Allowed roles to register as" field is a set of roles that can be assigned to users during the registration process. For example, if you set the "Allowed roles to register as" field to include the "Contractor" and "Client" roles, users will only be able to register as one of these two roles. If you try registering as a user with the "Administrator" role, you will not be able to do so, as the "Administrator" role is not included in the list of allowed roles.
Guest registers as
The "Guest registers as" field in the CodeMash Membership module allows you to specify the role applied to users who make purchases or perform other actions on your website or app without registering for an account. This can be useful if you want to differentiate between users who have registered for an account and those who have not.
Password complexity
The "Password complexity" field allows you to specify the complexity required for user passwords. This can help to improve the security of your website or app by ensuring that users choose strong, secure passwords.
Allow password reset
The "Allow password reset" field allows you to specify whether or not users can reset their passwords if they forget them. If you set this field to "Yes," users can reset their passwords using a password reset link.
Suppose the user chooses to reset their password using a password reset link. In that case, CodeMash will send an email (Email module must be enabled) to the user's registered email address with instructions on resetting their password. The user will then be redirected to a password reset screen, where they will be prompted to enter a new password. Once they have entered a new password, their account will be updated with the new password, and they will be able to log in with their new credentials.
Password reset token expiration (minutes)
The "Password reset token expiration (minutes)" field allows you to specify how long the token is valid before it expires. For example, if you set this field to "60," the password reset token will expire after 60 minutes. If the user does not use the token to reset their password within this time frame, they will need to request a new password reset token to reset their password.
Reset password callback
The "Reset password callback" field allows you to specify a URL to which the user will be redirected after the password reset process. This can be useful if you want to direct the user to a specific page on your website or app after they have reset their password.
Subscribe to news
The "Subscribe to news" allows you to specify whether or not newly registered users will be automatically subscribed to your marketing emails. It is common for companies and organizations to include a tickbox on the registration screen that allows users to opt-in to receive marketing emails. This tickbox typically includes language that explains that the user will receive marketing emails if they check the box. For example, the tickbox might say, "I agree to receive marketing emails from your company."
Send welcome email
The "Send welcome email" field allows you to specify whether or not a welcome email should be sent to newly registered users.
To use the "Send welcome email" field, you must enable the Email module and create a welcome email template. The welcome email template is a predefined email message sent to newly registered users. You can customize the content of the welcome email template to include any information you want to communicate to the user.
Allow invite users
The "Allow invite users" allows you to specify whether or not users can be invited to your website or app. You must enable the Email module and create an invite email template. The invite email template is a predefined email message sent to users who are invited to join your website or app. You can customize the content of the invite email template to include any information you want to communicate to the user.
Invitation token expiration (minutes)
The "Invitation token expiration (minutes)" field allows you to specify the length of time an invitation token will remain valid. An invitation token is a unique code that is sent to users who are invited to join your website or app. The invitation token is included in the invitation email message and can be used by the user to complete the registration process and gain access to your website or app.
Invitation callback
The "Invitation callback" allows you to specify a URL to which users will be redirected after completing the registration process using an invitation token. An invitation token is a unique code that is sent to users who are invited to join your website or app. The invitation token is included in the invitation email message and can be used by the user to complete the registration process and gain access to your website or app.
Verification by email needed
The "Verification by email needed" field allows you to specify whether or not newly registered users should verify their email addresses. This feature can be helpful if you want to ensure that only users with valid email addresses can access your website or app. To verify their email addresses, users will typically receive an email message containing a verification link. They can click on the link to complete the verification process and gain access to your website or app.
Verification token expiration (minutes)
The "Verification token expiration (minutes)" field allows you to set the amount of time that the verification token will remain valid after it is issued. For example, you might set this field to "60" to specify that the verification token will expire after one hour. If the user does not complete the verification process within this time frame, the verification token will expire, and the user will need to request a new verification token.
Verification callback
The "Verification callback" field allows you to specify the URL users will be redirected to after completing the verification process. For example, you might specify a URL that takes users to a specific page on your website or app, such as the homepage or a dashboard page.
User deactivation
The "User deactivation" field module allows you to specify an email template sent to users when they deactivate or delete their accounts on your website or app. You must have the Email module enabled to use the "User deactivation" field.
Deactivation token expiration (minutes)
The "Deactivation token expiration (minutes)" field module allows you to specify the length of time a deactivation token will remain valid. A deactivation token is a unique code sent to users when they deactivate or delete their accounts on your website or app.
The deactivation token is included in the deactivation email message that is sent to the user. Users can use it to confirm their intention to deactivate or delete their account and complete the process.
Deactivation callback
The "Deactivation callback" field allows you to specify a callback URL that will be used when a user deactivates or deletes their account on your website or app.
When a user deactivates or deletes their account on your website, you will be redirected to that URL.
