Skip to content
  • Documentation >
  • Users >
  • User authentication >
  • Login methods

Login methods

Two login methods are available: with User name or with email.

Providers for these two methods are ibexa.security.user_provider.username and ibexa.security.user_provider.email.

You can configure which method is allowed under the security configuration key:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
security:
    providers:
        ibexa:
            chain:
                providers: [ibexa_username, ibexa_email]

        ibexa_username:
            id: ibexa.security.user_provider.username

       ibexa_email:
            id: ibexa.security.user_provider.email

    firewalls:
        #...
        ibexa_front:
            # ...
            provider: ibexa

You can customize per User Field whether the email address used as a login method must be unique or not.

To check that all existing User accounts have unique emails, run the ibexa:user:audit-database command. It lists all User accounts with duplicate emails.

Caution

Because logging in with email was not available until version v3.0, you can come across issues if you use the option on an existing database.

This may happen if more than one account uses the same email address. Login through the User name will still be available.

To resolve the issues, run ibexa:user:audit-database and manually modify accounts that have duplicate emails.

Login rules

You can set the rules for allowed User names in the Back Office per User Field.

The rules are set using regular expressions.

For example, to ensure that User names can only contain lowercase letters, set [a-z]+$ as Username pattern:

Setting a User name pattern

To check that all existing User accounts have names that fit the current pattern, run the ibexa:user:audit-database command. It checks all User accounts in the database and list those that do not fit the pattern.