Configuring Multi-Tenancy Security

The following information describes how to configure My MATRIXX security in Keycloak for multi-tenancy. For detailed information about configuring roles in Keycloak, see the Keycloak documentation.

Important: After configuring the My MATRIXX roles in Keycloak, the roles assigned to users in My MATRIXX do not apply and only the roles assigned to users in Keycloak are used.
For technical and commercial users, add the roles described in My MATRIXX Roles to Keycloak.
Table 1. My MATRIXX Roles
My MATRIXX Role Name Keycloak Role Name
Tenant Administration MTX_MM_tenantadmin
Tenant Manager MTX_MM_tenantmgr
Tenant User MTX_MM_tenantuser
Note: A user can have only one of the My MATRIXX roles. Any other roles required by tenant managers or tenant users are assigned by My MATRIXX.
For commercial users (tenant managers and tenant users), use the information in Client Mappers to map the user to the token.
Table 2. Client Mappers
Name Mapper Type User Attribute Token Claim Name Claim JSON Type Description
domain User Attribute domain domain String The domain associated with the user. Commercial users can be associated with only one domain.
tenant_id User Attribute tenant_id tenant_id String The tenant profile ID associated with the user. Commercial users can be associated with only one domain.
roles User Attribute role_name roles String The name of the role. Can be the tenantmgr role or the tenantuser role.

For more information about configuring OAuth 2.0 authentication, see the discussion about OAuth 2.0 identity and access management.