How to check: Am I using the Keycloak username provided in my custom realm (also called preferred name)?

[zsamji]

Keycloak as a system generated concept called the preferred name. As we move our clients to gold we want to be very aware of what that value is. The guide below will help you decipher if you are using the keycloak username in your application as you will need to consider impacts to your migration to gold.

RC How To Guide:
https://chat.developer.gov.bc.ca/file-upload/pQbCWg2Gqxb2asS9S/How_to_guide__Are_you_using_the_keycloak_username_provided_in_your_custom_realm_(also_called_preferred_name)_-compressed.pdf?download

[zsamji]

1. Review your application code to see where you are binding the user and its attributes.

2. Does your application bind a user with your Keycloak custom realm username?
   If so, go into your custom Keycloak realm; then search all users, view all users and note the syntax in the username column.
   

3. If your application binds a user to this username value, you are making use of the preferred name. Note: Preferred names are problematic as they are not unique in the long term.

The SSO team recommends that you rely on the government provided user GUID, and not the username/preferred name, to ensure it is unique in the long term. This means you may need to refactor your code.