Skip to main content
Version: 2.1.0

IAMS

UNH is tightly coupled with IAMS to resolve the recipient contact information such as Email & FCM token by keycloak user id. Please make sure that you have the necessary resources created in IAMS before proceeding with UNH.

Necessary resources needed for UNH

  • keycloak client for UNH to call IAMS-AAS API
  • keycloak user with Email and FCM token attributes
important

It is essential to have a fully functional IAMS installed before starting with UNH. To learn more about IAMS, please refer to IAMS docs.

Keycloak client for UNH to call IAMS-AAS API​

After deploying IAMS in your Kubernetes cluster, you can access its admin console to create a new client.

  1. Login to Keycloak Admin Console and switch the realm. This example demonstrates using AOH realm.

Select Default Realm

  1. Click on Clients in the side menu and click on Create client button.

Create Client

  1. Go through the steps below to create a new client.
  • Fill up the required fields (you can enter your own value here) Create Client Step 1
  • Set capabilities settings Create Client Step 2
  • Leave the fields below empty and click on Save. Create Client Step 3
  1. Click on Service accounts roles tab and click on Assign role.

Assign Role

  1. Assign the sys-admin role to the client by selecting Filter by realm roles at the top left.

Sys-admin

  1. You have created a new client in AOH-IAMS. Go to the Credentials tab in the client details page and take note of the client id and client secret which will be needed in UNH deployment.

Client Secret

Keycloak user with Email and FCM token attributes​

note

Generating an FCM token is outside the scope of UNH. For more information on generating an FCM token from a mobile device, refer to the Google FCM guide.

By default, Keycloak does not come with the FCM token attribute configured in the user profile. We need to add the FCM token attribute to allow UNH to retrieve users' mobile FCM tokens and send push notifications.

  1. Click on Realm Settings in the side menu and click on User profile tab. Inside the User profile tab, click on Add attribute button.

User Profile

  1. Follow the settings below to create a FCM token attribute.

Fcm Token Attribute 1 Fcm Token Attribute 2

  1. Once FCM token attribute is created, we can set both Email and FCM token attributes when we create a new user. Click on Users in the side menu and click on Add user. Make sure to use a real, working Email address and FCM token.

Create User Form