Genesys Cloud - Developer Community!

We need to generate a report containing three columns: Group, Role, and Permission. Are there any APIs available that can be parsed to produce this report? We have reviewed the endpoints under the Groups, Analytics, and Search categories but have not found a suitable option. The GET Group Details API indicates whether roles are enabled but does not provide detailed information.

#PlatformAPI

------------------------------
Avinash Basutkar
Senior Technology Analyst
------------------------------

Hi Avinash,

Take a look at our API-Explorer here: https://developer.genesys.cloud/devapps/api-explorer

It has a pretty decent search function:

Groups.          https://developer.genesys.cloud/devapps/api-explorer#get-api-v2-groups
Roles.             https://developer.genesys.cloud/devapps/api-explorer#get-api-v2-authorization-roles
Permissions.   https://developer.genesys.cloud/devapps/api-explorer#get-api-v2-authorization-permissions

Thanks,
  John

Is there anyway to get combine these? I would like to pull all roles for each group. I'm hoping I don't need to look up each group indiviually. I was looking at GET /api/v2/authorization/subjects/{subjectId}, but was hoping I could get more than 1 group at a time.

Thanks,

Megan

Unfortunately, there is no bulk API that returns the roles assigned to multiple groups in a single request.

To achieve a Group → Role → Permission report, the recommended approach is to use a script that orchestrates multiple API calls:

1. Retrieve all groups using GET /api/v2/groups.
2. For each group, call GET /api/v2/authorization/subjects/{groupId} to retrieve the roles assigned to that group.
3. For each unique role returned, call GET /api/v2/authorization/roles/{roleId} to retrieve the associated permissions.
4. Combine the results into the desired report format:

To improve efficiency, the script should cache role details so that each role is queried only once, even if it is assigned to multiple groups.

While this requires one authorization/subjects request per group, it can be automated using PowerShell, Python, JavaScript, or any preferred scripting language. The API calls can also be executed concurrently (subject to API rate limits) to reduce the overall execution time.

At this time, Genesys Cloud does not provide a single endpoint that returns all groups along with their assigned roles and permissions in one response, so scripting is the recommended solution.