Skip to content

User Registration#

Overview#

The Gluu Server includes two custom scripts to support a self-service user registration process:

  • user_registration: This script implements a very basic user registration process without email activation.

  • user_confirm_registration: This script adds an email activation sequence to the user registration process.

Note

To implement a custom registraton workflow (recommended!), follow the tutorial in our SCIM 2.0 docs.

Enable User Registration#

To enable user registration via the Gluu Server, follow these steps:

  1. Navigate to Manage Custom Scripts and select the User Registration tab.

  2. Enable the user_registration script and press save.

    user registration script

  3. To add an email activation sequence, also enable the user_confirm_registration script and configure SMTP.

  4. New users will now be able to register for accounts at: https://<hostname>/identity/register.

Adding Attributes to Registration#

A limited number of attributes are present in the default registration form. More attributes can be added as needed by following the doc for adding attributes.

Manual Approval of New Users#

By default, the Custom property (key/value) field will include the values: enable_user and true. This enables new users to sign in as soon as registration is complete. If new users should be manually reviewed and approved, set this value to false.

image

Enforcing Unique Email Addresses#

Administrators can choose whether all email addresses should be unique. By default, uniqueness is enforced. To turn email uniqueness off, make the below changes in oxTrust and the LDAP.

Warning

When uniqueness is disabled, more than one user can register with the same email address.

oxTrust#

  1. Log in to the Gluu Admin UI
  2. Navigate to Configuration > JSON Configuration
  3. Select the oxTrust Configuration tab
  4. Select the appropriate option in the enforceEmailUniqueness field
  5. Save

OpenDJ#

  1. Log in to the Gluu container
  2. Run this command to list all plugins:
    /opt/opendj/bin/dsconfig -h hostname -p 4444 -D "cn=directory manager" -w yourPassword -n list-plugins
  3. To disable the email uniqueness plugin, run this command:
    /opt/opendj/bin/dsconfig -h hostname -p 4444 -D "cn=directory manager" -w yourPassword -n set-plugin-prop --plugin-name "Unique mail address" --set enabled:false
  4. If you want to re-enable the email uniqueness plugin, run this command:
    /opt/opendj/bin/dsconfig -h hostname -p 4444 -D "cn=directory manager" -w yourPassword -n set-plugin-prop --plugin-name "Unique mail address" --set enabled:true
  5. Restart the opendj service.

Design customizations#

To modify the look and feel of the registration page, follow the customization doc.