Skip to main content

AE Apps

AE apps or connected apps are external apps created specifically for AE users. To use the external app, you must register and authenticate the app through AE server.

tip

Connected APP with SSO is supported for OKTA and KeyCloak IDPs. For SSO OpenID Connect (OIDC) protocol, you must add the AE App’s ID, as one more redirect URL in the IDP you are using, that is, OKTA or KeyCloak. For example, https://localhost:8443/aeui?app_id="appID of AE-APP".

Registry​

To use the AE apps through AE UI, you need to register the apps.

tip

The menu option is available only for (Tenant) Admin.

To register an AE app:

  1. Navigate to AE Apps → Registry in the menu. The Registry page appears.

  2. Click Add New. The App Registration dialog appears.

  1. Enter the following field details:
Field NameDescription
App TypeSelect the type of app you want to register. Available options are:- Authorization Code Flow: Select if you want to register an app.Client Credentials Flow: Select if you want to register machine-to-machine applications, that is, there is no user identity involved.
App Name*Enter the name of the app you want to register. Note: The field is unavailable if the App Type is Client Credentials Flow.
App URL*Enter the URL of the app you want to register.Note: The field is unavailable if the App Type is Client Credentials Flow.
Redirect URl*Enter the correct URL of the app you want to register.
Note: - The value is used for redirection to the app after successful authentication. - The field is unavailable if the App Type is Client Credentials Flow.
App RolesIf the App Type is Authorization Code Flow, then enter the role which you can assign to the existing AE users. OR If the App Type is Client Credentials Flow, then select the role from the list. Note: If the App Type is Client Credentials Flow, then you will work with User Defined Roles that do not have Web Portal Access.
  1. Click Add. The app is registered and the AE server will generate an app ID and password.

App Type is Client Credentials Flow

App Type is Authorization Code Flow

tip

You must save the client ID and client secret, as you will require the details to use the registered AE app.

tip

To view the app secret, click the Eye icon. To copy the app ID and app secret, click the Copy icon. To generate a new password for the AE app, click Generate new secret. The Tenant Admin can register multiple AE apps.

  1. Click Update. The registered AE app, appears on the Registry page.

tip

In the Actions column:

  • To modify the app details, click Edit.
  • To remove the registered app, click Delete.

To assign roles to AE users:

  1. On the Registry page, click Assign Roles. The User-Role Assignment dialog appears.

  1. Enter the following field details:
Field NameDescription
Select AppSelect the app to which you want to assign the AE user.
Select Role*Select the role that you want to assign to the AE user.
Select UsersSelect the AE users to which you want to assign the AE app role.
  1. Click Update. The role is assigned to the AE user.
tip

You can assign the app role to multiple AE users.

App Catalogue​

Use the App Catalogue to view and access the registered AE app.

tip

Only those AE apps whose App Type is Authorization Code Flow, appear in the App Catalogue.

To access the AE app:

You can access the app in any of the following ways:

  • Sign in to AE, and go to AE Apps → App Catalogue. You will see the AE apps assigned to the user.

    Click the app tile. You will see the app's sign-in page.

OR

  • Use the Set Workflow Result step with AE-AppLink option, and access the app through the Requests page.

|------------|---------------------------------------------------------| | 🖎Note | For step details, see the Plugin Reference Guide 2. | | | | | | For how to access the AE app, see [**Viewing Request |

Details**](#_Viewing_Request_Details).
Last updated on