...

When restoring the default configuration, the script will also update StudioService.exe.config to set the correct authority url for the newly created realm and the new client secret for the studio-server client.

Managing Users & Groups & Roles

When managing users, groups and roles, make sure that you have selected the Studio from the Realm selection menu:

Image Removed

Groups & Roles

Adding, editing and removing groups and roles in Keycloak is relatively straightforward, from the navigation panel select either Roles or Groups, and the main view will list all roles or groups. From this view you can add, edit or delete roles or groups.

Users can be added to multiple groups, and they can be assigned multiple roles.

Roles can also be assigned to groups, effectively assigning those roles to all members of the group.

Ultimately it is the roles a user has in Keycloak (either directly or via groups it is a member of) that will determine which roles (and permissions) the user has in Encore and the Studio server.

Which Studio role a user has based on the given Keycloak roles is determined in the Studio configuration via the role mappings. See Studio Security Modes for how to configure role mappings.

The Studio role in turn will determine which permissions a user has in the Studio. See User access and management for more information on Studio roles and permissions.

Users

Adding, editing and removing users is relatively straightforward in Keycloak. From the navigation panel select Users, the main view will not list all by default, you can choose "View all users" to load all users, or search for a user from the search bar.

Adding a new user can be done with the Add user button in the top right. Only thing to keep in mind when adding a user, is that we currently only support authentication with a password, new users must be set up so that they can sign in with a password. To do this, first create a user: only the username is required, and optionally you can assign the user to one or more groups.

Then edit the user, select Credentials and enter a password:

Image Removed

If the temporary toggle is on, then the user must first update their password before they can sign into Encore.

Users can always update their password (temporary or not) in the Account console for the Studio realm at http://<domain:port>/Keycloak/realms/<realm>/account, or http://localhost:160/Keycloak/realms/BlueriqStudio15/account in a typical installation.

User Federation: NTLM/LDAP

It is possible to link Keycloak to an Active Directory using User Federation. This will allow users to sign in using their AD credentials. To set this up:

...

User Federation: Kerberos

It is possible to link Keycloak to an Active Directory with the Kerberos protocol using User Federation. This will allow users to sign in using their AD credentials. To set this up:

1. Select User Federation from the navigation panel and then select "Add Kerberos providers".
   Image Removed
2. Choose a UI display name
3. Enter the Kerberos Realm
   Image Removed
4. Enter the principal for the server 
   Image Removed
5. Enter the location of the keytab file containing credentials of the given principal
   Image Removed
6. Set Allow Password Authentication to On:
   Image Removed
7. Set Edit Mode to READ_ONLY
   Image Removed
8. In order to test it, a AD user can try to sign in to the Account console for the Studio realm at http://<domain:port>/Keycloak/realms/<realm>/account