第29章 Security Management REST API for Business Central groups, roles, and users

Procedure

1. Identify the relevant API endpoint to which you want to send a request, such as [GET] /groups to retrieve groups in Business Central.

2. In a REST client or curl utility, enter the following components for a GET request to /groups. Adjust any request details according to your use case.

   For REST client:

   • Authentication: Enter the user name and password of the Business Central user with the admin role.

   • HTTP Headers: Set the following header:

     • Accept: application/json
   • HTTP method: Set to GET.
   • URL: Enter the Security Management REST API base URL and endpoint, such as http://localhost:8080/decision-central/rest/groups.

   For curl utility:

   • -u: Enter the user name and password of the Business Central user with the admin role.

   • -H: Set the following header:

     • Accept: application/json
   • -X: Set to GET.
   • URL: Enter the Security Management REST API base URL and endpoint, such as http://localhost:8080/decision-central/rest/groups.

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -X GET "http://localhost:8080/decision-central/rest/groups"

3. Execute the request and review the KIE Server response.

   Example server response (JSON):

   [
     	{
   		"group1"
   	},
   	{
   		"group2"
   	}
   ]

4. In your REST client or curl utility, send another API request with the following components for a POST request to /users/{userName}/groups to update the groups assigned to a user. Adjust any request details according to your use case.

   For REST client:

   • Authentication: Enter the user name and password of the Business Central user with the admin role.

   • HTTP Headers: Set the following header:

     • Accept: application/json
     • Content-Type: application/json
   • HTTP method: Set to POST.
   • URL: Enter the Security Management REST API base URL and endpoint, such as http://localhost:8080/decision-central/rest/users/newUser/groups.
   • Request body: Add a JSON request body with the identification data for the new group:

   [
     "newGroup"
   ]

   For curl utility:

   • -u: Enter the user name and password of the Business Central user with the admin role.

   • -H: Set the following headers:

     • Accept: application/json
     • Content-Type: application/json
   • -X: Set to POST.
   • URL: Enter the Security Management REST API base URL and endpoint, such as http://localhost:8080/decision-central/rest/users/newUser/groups.
   • -d: Add a JSON request body or file (@file.json) with the identification data for the new group:

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X POST "http://localhost:8080/decision-central/rest/users/newUser/groups" -d "["newGroup"]"

   curl -u 'baAdmin:password@1' -H "Accept: application/json" -H "Content-Type: application/json" -X POST "http://localhost:8080/decision-central/rest/users/newUser/groups" -d @user-groups.json

5. Execute the request and review the KIE Server response.

   Example server response (JSON):

   {
     "status": "OK",
     "message": "Groups [newGroup] are assigned successfully to user wbadmin"
   }

   If you encounter request errors, review the returned error code messages and adjust your request accordingly.