Register an application

An application that communicates with the Aikyam Identity Provider is defined as a client. This could be a web browser-based app, or a server app. Administrators will register the application (i.e. client) in the identity console to enable CIAM (Customer Identity and Access Management) solution. This allows you to manage users, govern their access, and protect resources within the applications, all through a unified interface. Upon request, the super admin or app admin will register the application and configure its settings based on specified requirements. The application types supported by the Aikyam identity platform are:

• Web applications – a customizable web application that uses redirects for authentication
• Machine-to-Machine applications – a backend service application that uses secure credentials for automated authentication between systems.
• Mobile applications – Native – a mobile, desktop, service, or a smart device application that uses redirects for authentication.

Let’s see how to register an application in the Aikyam Identity Console.

To register a web application that uses redirects for authentication,

1. Sign-in to the Aikyam Identity Console using either your MSID or tenant ID, depending on your role.
2. In the left navigation pane, select Applications.
3. Click Register Application.
   1. Application Name: Enter the name of the application (mandatory field).
   2. Choose an application type: Select Web Application to register a customizable web application that uses redirects for authentication.
   3. Application ID: By default, this field is pre-filled with a system-generated ID. To customize it, click Customize ID, then enter a unique app ID.
   Note: Recommended: Refer to the IR Form for the application name and AID ID. Use an abbreviated name with the last 5 digits of the AID ID, followed by "N" to indicate a new implementation. For instance, Finance Tracker app with AIDE ID ending in 54321 becomes FT54321N.
   Instead, to generate an ID automatically, click Auto-Generate.
   d. Subject type
   Select one of the following subject types:
   • Public – Uses the same user ID across all applications within the organization.
   • Pairwise – Generates a unique user ID for each application.

   If you select Pairwise from the dropdown, you must enter the Sector Identifier URL.

   • Sector identifier: Enter the valid URL (trusted redirect URI) that defines a group of related applications.

   Important: If the entered URL is invalid, authentication may fail.
   Note: We recommend pairwise for applications requiring user privacy and data isolation across multiple relying parties. For example, the Optum Provider portal could use pairwise to keep patient data private between healthcare providers.
   e. Login callback URL – Define the endpoint where users are redirected after successful login.
4. Click Register.

The application is successfully onboarded.

Now, select Proceed to navigate to the application configuration page or select Close to return to the Applications landing page.

To register an M2M application,

To generate an ID automatically, click Auto-Generate.

Callback URL: Define the endpoint where users are redirected after successful login.

5. Click Register. The application is successfully onboarded.

To generate an ID automatically, click Auto-Generate.

Now, select Proceed to navigate to the application configuration page or select close to return to the Applications landing page.

To register a native application:

The application is successfully onboarded. Now, select Proceed to navigate to the application configuration page or select Close to return to the Applications landing page.