[1.3.x] RHIDP-3709: how admins can track RHDH usage by users (#515)

* RHIDP-3709: how admins can track RHDH usage by users

* Peer comments

---------

Co-authored-by: Heena Manwani <[email protected]>

Author: openshift-cherrypick-robot

assemblies/assembly-configuring-authorization-in-rhdh.adoc

@@ -37,6 +37,12 @@ include::modules/admin/proc-rbac-ui-edit-role.adoc[leveloffset=+2]
 include::modules/admin/proc-rbac-ui-delete-role.adoc[leveloffset=+2]
 
 
+include::modules/admin/con-user-stats-rhdh.adoc[leveloffset=+1]
+
+
+include::modules/admin/proc-download-user-stats-rhdh.adoc[leveloffset=+2]
+
+
 include::modules/admin/con-rbac-rest-api.adoc[leveloffset=+1]
 
 

modules/admin/con-rbac-rest-api.adoc

@@ -39,6 +39,7 @@ Base URL::
 --
 
 The base URL for RBAC REST API requests is `pass:c[http://SERVER:PORT/api/permission/policies]`, such as `pass:c[http://localhost:7007/api/permission/policies]`.
+
 --
 
 Endpoints::

modules/admin/con-user-stats-rhdh.adoc

@@ -0,0 +1,8 @@
+[id='con-user-stats-rhdh_{context}']
+= User statistics in {product}
+
+In {product}, the `licensed-users-info-backend` plugin provides statistical information about the logged-in users using the Web UI or REST API endpoints.
+
+The `licensed-users-info-backend` plugin enables administrators to monitor the number of active users on {product-short}. Using this feature, organizations can compare their actual usage with the number of licenses they have purchased. Additionally, you can share the user metrics with {company-name} for transparency and accurate licensing. 
+
+The `licensed-users-info-backend` plugin is enabled by default. This plugin enables a *Download User List* link at the bottom of the *Administration -> RBAC* tab.

modules/admin/proc-download-user-stats-rhdh.adoc

@@ -0,0 +1,16 @@
+[id='proc-download-user-stats-rhdh_{context}']
+= Downloading active users list in {product}
+
+You can download the list of users in CSV format using the {product-short} web interface.
+
+.Prerequisites
+
+* RBAC plugins (`@janus-idp/backstage-plugin-rbac` and `@janus-idp/backstage-plugin-rbac-backend`) must be enabled in {product}.
+* An administrator role must be assigned.
+
+.Procedure
+
+. In {product}, navigate to *Administration* and select the *RBAC* tab.
+. At the bottom of the *RBAC* page, click *Download User List*.
+. Optional: Modify the file name in the *Save as* field and click *Save*.
+. To access the downloaded users list, go to the *Downloads* folder on your local machine and open the CSV file.

modules/admin/ref-rbac-rest-api-endpoints.adoc

@@ -975,3 +975,80 @@ Deletes a conditional policy for the specified ID.
 ----
 --
 
+== User statistics
+
+The `licensed-users-info-backend` plugin exposes various REST API endpoints to retrieve data related to logged-in users.
+
+No additional configuration is required for the `licensed-users-info-backend` plugin. If the RBAC backend plugin is enabled, then an administrator role must be assigned to access the endpoints, as the endpoints are protected by the `policy.entity.read` permission.
+
+The base URL for user statistics endpoints is `pass:c[http://SERVER:PORT/api/licensed-users-info]`, such as `pass:c[http://localhost:7007/api/licensed-users-info]`.
+
+[GET] /users/quantity::
++
+--
+Returns the total number of logged-in users.
+
+.Example request
+[source,bash]
+----
+curl -X GET "http://localhost:7007/api/licensed-users-info/users/quantity" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $token"
+----
+
+.Example response
+[source,json]
+----
+{ "quantity": "2" }
+----
+--
+
+[GET] /users::
++
+--
+Returns a list of logged-in users with their details.
+
+.Example request
+[source,bash]
+----
+curl -X GET "http://localhost:7007/api/licensed-users-info/users" \
+-H "Content-Type: application/json" \
+-H "Authorization: Bearer $token"
+----
+
+.Example response
+[source,json]
+----
+[
+  {
+    "userEntityRef": "user:default/dev",
+    "lastTimeLogin": "Thu, 22 Aug 2024 16:27:41 GMT",
+    "displayName": "John Leavy",
+    "email": "[email protected]"
+  }
+]
+----
+--
+
+[GET] /users::
++
+--
+Returns a list of logged-in users in CSV format.
+
+.Example request
+[source,bash]
+----
+curl -X GET "http://localhost:7007/api/licensed-users-info/users" \
+-H "Content-Type: text/csv" \
+-H "Authorization: Bearer $token"
+----
+
+.Example response
+[source,csv]
+----
+userEntityRef,displayName,email,lastTimeLogin
+user:default/dev,John Leavy,[email protected],"Thu, 22 Aug 2024 16:27:41 GMT"
+----
+--
+
+