Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Although each realm can have variations in what information we collect., or what authentication process is setup, there is a minimum set of recommendations that should be follow in each realm setup.

...

Field

Mandatory

Type

1

First name

Mandatory

Native to keycloak

2

Surname

Mandatory

Native to keycloak

3

Username

Mandatory

Native to keycloak

4

Email address

Mandatory

Native to keycloak.
Keycloak enforce uniqueness of email

5

Phone numberMandatory

Recommended as mandatory

+CCC NNNNNNN
PENDING: can it be set as unique?

6

WhatsAppID

MandatoryOptional

+CCC NNNNNNN

7

Preferred Language

Mandatory

additional field

8

Gender (or User profiling
(Gender, Age, or Age range)

Optional

additional field

9

, Date of birth)

Optionalper realm

additional field

109

Type of worker

per realm

additional field
Drop down value per realm

1110

Employee ID

per realm

additional field

1211

Health Unit

per realm

additional field
Drop down value per realm

1312

City/Town

Optional

additional field
Drop down value per realm

1413

SubNational L2
(rename for each realm)

per realm

additional field
Drop down value per realm

1514

SubNational L1
(rename for each realm)

per realm

additional field
Drop down value per realm

Information not collected:

  • Country: not necessary, as the user will be on a real that

Use of email

  • Expected for all users. Keycloak will enforce uniqueness within the Realm

  • For self-created accounts, users will receive an email that

...

  • they need to open an visit the suggested URL for email validation

  • For manually created account or imported accounts, email will set to ‘verified’

Setting username

By realm - Keycloak enforces uniqueness

A combination of first name and last name can be used, but must be consistent across the realm accounts

  • First Name + “.” + Last Name (rodolfo.melia)

  • Initial First Name + “.” + Last Name (r.melia)

  • Initial First Name + Last Name (rmelia)

Gender

if you ask for gender, consider a 3rd option for ‘do not with to disclose’

F

Female

M

Male

Do not want to disclose

Self Registration

  • Auto-suggested based on a combination listed above (small custom dev)

  • Will display an error is username is taken (or if possible as a number: rmelia2)

  • email account will need to be validated (see email section)

Authentication guidelines

In general, we will setup Keycloak mirroring PSI’s authentication guidelines which can be summarised as detailed below.

...

  • 8 characters or more

  • Never expires

  • must include

    • one lower case,

    • one upper case,

      one number and

    • one special character

  • Not user name

  • Not email

Password recovery

Self-register

PSI' 2FA
Status
colourGreen
titleimplemented June 2023

...