Keycloak settings page field descriptions

Enable Single Sign-On

The options are:

Yes: Enables the connection between Avaya Experience Portal and Keycloak.
No: Disables the connection between Avaya Experience Portal and Keycloak.

	Note:
	When you click Apply, Avaya Experience Portal verifies the Keycloak settings only if Enable Single Sign-On is set to Yes. If Enable Single Sign-On is set to No, Avaya Experience Portal saves the changes but does not verify the Keycloak settings.

Authorization Server URL

The URL of the Keycloak server.

Default Keycloak Realm

The realm in Keycloak where users are stored.

For single tenancy, the Default Keycloak Realm is the realm where users for this tenant are stored. It is used in the authentication of the user if a realm is not passed by other means such as cookie.

This value is optional.

Keycloak Client ID

The client ID of a client created in Keycloak.

Avaya Experience Portal uses the Keycloak Client ID to request information from Keycloak and to authenticate a user.

Keycloak Client Secret

The secret of a client created in Keycloak.

Avaya Experience Portal uses the Keycloak Client Secret to request information from Keycloak and to authenticate a user.

Keycloak Realm

The realm in Keycloak where users are stored.

The Keycloak Realm can be mapped to an organization.

For an existing Keycloak Realm map:

When system roles are selected, the name of the organization displays as N/A.
When organization roles are selected, the particular organization name is displayed.

Organization

The EPM organization can be mapped to a particular Keycloak realm using Organization.

For a new Keycloak Realm map, select System or Organization.

For an existing Keycloak Realm map:

When system roles are selected, the name of the organization displays as N/A.
When organization roles are selected, the particular organization name is displayed.

Keycloak Role Name

The roles associated with users in Keycloak server role mapping for a particular Keycloak realm.

The Keycloak Role Name can be mapped to Experience Portal roles per Realm and Organization.

Keycloak Realm

The realm in Keycloak where users are stored.

Depending on the Keycloak realm mapping, if the realm is associated with an organisation, the system displays the available roles for the organisation.

System: If the realm is associated with System, all the available System roles are displayed, and the Organization options are disabled.
Organization: If the realm is associated with Organization, all the available Organization roles for the selected organization are displayed and the System options are disabled.

For an existing Keycloak Role map:

When system roles are selected, the name of the organization displays as N/A.
When organization roles are selected, the particular organization name is displayed.

Organization

The organization roles that are associated with an organization.

For a new Keycloak Role map, use the Keycloak Realm column to select a particular realm. Depending on the realm mapping, the System or Organization roles associated with each group are displayed.

Assigned Roles

The roles associated with the existing group maps.

You can use the check boxes to select one or more user roles to associate with a new group map name.