From e5d7159f72ad6147c4dfeec3b4931d5d27aeaecc Mon Sep 17 00:00:00 2001 From: Arnab Dutta Date: Fri, 23 Feb 2024 18:08:36 +0530 Subject: [PATCH] docs: add documentation for admin-ui screen supporting editable UI configurations. #1582 Signed-off-by: Arnab Dutta --- docs/admin/admin-ui/admin-menu.md | 8 ++++++++ docs/admin/admin-ui/configuration.md | 19 +++++++++++++------ 2 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/admin/admin-ui/admin-menu.md b/docs/admin/admin-ui/admin-menu.md index 42049d219..48e8da374 100644 --- a/docs/admin/admin-ui/admin-menu.md +++ b/docs/admin/admin-ui/admin-menu.md @@ -113,3 +113,11 @@ This is a line graph showing month-wise active users under a selected date range ![image](../../assets/admin-ui/mau.png) +## Settings + +The Gluu Flex Admin UI provides a user-friendly interface for managing various UI settings of this web application. This page has the following fields. + +- **List paging size:** This field allows to define the default paging size for all search pages within the Admin UI. +- **Config API URL:** The read-only URL of the Jans Config API is used by the Admin UI for interaction. +- **Admin UI Session Timeout (In Minutes):** This field determines the maximum idle time allowed before a user is automatically logged out of the Admin UI. +- **Admin UI authentication method (ACR)** This dropdown enables user to select the default authentication method to be used in the Admin UI. diff --git a/docs/admin/admin-ui/configuration.md b/docs/admin/admin-ui/configuration.md index 90e477191..9192ad672 100644 --- a/docs/admin/admin-ui/configuration.md +++ b/docs/admin/admin-ui/configuration.md @@ -86,7 +86,7 @@ The information is stored in json format with following attributes. |Attribute Name|Description| |--------------|-----------| -|authServerClient|Object with Auth Server client details| +|auiWebClient|Object with Web OIDC client details| |opHost|Auth Server hostname| |clientId| Client Id of OIDC client used to access Auth server| |clientSecret| Client Secret of OIDC client used to access Auth server| @@ -96,20 +96,27 @@ The information is stored in json format with following attributes. |postLogoutUri|Url to be redirected after Admin UI logout| |frontchannelLogoutUri|Front channel Logout Uri| -### OIDC Client Details for Token Server +### OIDC Client Details for Backend API Server -Similarly, Gluu Flex Admin UI needs OIDC client details to interact with the Token Server. This enables the UI to request and manage access tokens required to access `Jans Config API` protected resources. +Similarly, Gluu Flex Admin UI needs OIDC client details to interact with the Janssen Server via. `Jans Config API` protected APIs. The Backend API client enables the UI to request and manage access tokens required to access `Jans Config API` protected resources. The information is stored in json format with following attributes. |Attribute Name|Description| |--------------|-----------| -|tokenServerClient|Object with Token Server client details| +|auiBackendApiClient|Object with Backend API client details| |opHost|Token Server hostname| |clientId| Client Id of OIDC client used to access Token server| |clientSecret| Client Secret of OIDC client used to access Token server| |tokenEndpoint|Token endpoint of token server| +### Configuration Properties for User-Interface + +|Attribute Name|Description| +|--------------|-----------| +|uiConfig|Object with UI configuration attributes| +|sessionTimeoutInMins|The admin UI will auto-logout after a period of inactivity defined in this field.| + ### OIDC Client Details for License Server Access to the License APIs is managed through OIDC client details. These details allows the Gluu Flex Admin UI Backend to generated access token to allow the retrieval of license-related information using license APIs. @@ -140,7 +147,7 @@ The information is stored in json format with following attributes. ```text { "oidcConfig": { - "authServerClient": { + "auiWebClient": { "redirectUri": "https://your.host.com/admin", "postLogoutUri": "https://your.gost.com/admin", "frontchannelLogoutUri": "https://your.host.com/admin/logout", @@ -157,7 +164,7 @@ The information is stored in json format with following attributes. "clientId": "2001.aaf0b8eb-a82e-4798-b1a0-e007803a6568", "clientSecret": "GGO4t1uixrTpl4Rizt3zag==" }, - "tokenServerClient": { + "auiBackendApiClient": { "tokenEndpoint": "https://your.host.com/jans-auth/restv1/token", "scopes": [ "openid",