Genesys Cloud - Developer Community!

 View Only

Sign Up

  • 1.  Getting a users' list of divisions assigned to each of their roles

    Posted 08-26-2025 15:42

    Hello,

    I'm in the process of building SelfService webpage functionalities for our organization, and part of the requirements are to display the role names and divisions assigned to the user for each role.
    (similar to how it displays on the user's role page:)


     In trying to minimize the number of API calls we have to make to display, I've been attempting to utilize the response from the endpoint /api/v2/authorization/roles/{roleId}/subjectgrants when iterating over the list of roles that have been returned for a user. I see that it has an expand option to allow more detailed results to be requested, however, I can't find a list of acceptable values that this parameter can take. Ultimately, I'd be looking for getting the 'Name' value of the entity (instead of just the GUID), but it doesn't seem to return any additional information when passing in the value into the expand array:

    (example:)

    Thanks,
    Henry Halling


    #PlatformSDK

    ------------------------------
    Henry Halling
    Communications, Collaboration Technologist
    ------------------------------


  • 2.  RE: Getting a users' list of divisions assigned to each of their roles

    Posted 08-27-2025 06:14
    Edited by Brian Jones 08-27-2025 06:15

    Hello Henry - If you're looking to get both the user & their assigned role(s), this API has worked for us when we expand on the authorization field:

    GET /api/v2/users?expand=authorization HTTP/1.1

    If you're trying to pull back all of the roles with the names, respective descriptions, & assigned user counts so you can build a role reference table in your tool, this API should get those for you:

    GET /api/v2/authorization/roles?userCount=true



    ------------------------------
    Brian T. Jones | Ascension | Senior Specialist - Technology
    ------------------------------



  • 3.  RE: Getting a users' list of divisions assigned to each of their roles

    Posted 09-08-2025 16:41

    Hey @Brian Jones. Unfortunately this doesn't quite cover what I'm looking for. I'm specifically looking for getting all the division names (associated with the respective division GUID) that the user has access to for each of their roles... Since division access is critical to what they are allowed to see in our SelfService. I'm finding ways of getting the data using multiple different API calls, but I was hoping someone would be able to tell me if 'expand' is implemented for '/api/v2/authorization/roles/{roleId}/subjectgrants', as by itself, it's only giving GUID information back- which is essentially useless without additional API calls to determine what those correspond to.



    ------------------------------
    Henry Halling
    Communications, Collaboration Technologist
    ------------------------------

    Original Message


  • 4.  RE: Getting a users' list of divisions assigned to each of their roles

    Posted 09-09-2025 00:28
    Edited by Brian Jones 09-09-2025 00:28

    Got it. The short answer to your pressing question is it doesn't seem you'll be able to run an 'expand' to get what you need from '/api/v2/authorization/roles/{roleId}/subjectgrants'. That said, maybe there are other options you can try?

    Did you consider the get /api/v2/authorization/subjects/{subjectId} API where the subjectId is essentially the User GUID? The JSON you get back includes both the assigned Roles and corresponding Division names (& GUIDs) assigned to that Role.

    If that doesn't suffice and given you're building your own Self-Service page, have you considered:

    1. Running the Divisions API to get the list of Divisions out of the system and directly into the tables behind your Self-Service tool (e.g. on a nightly basis.)
    2. That way if you prefer the '/api/v2/authorization/roles/{roleId}/subjectgrants' API you can bump the Division GUIDs it returns up against your exported Division table to get the actual Division name.

    Although we use the former options to match Roles & corresponding Divisions, the Division export to a backend table has proven useful for other self-service features our tools offer.



    ------------------------------
    Brian T. Jones | Ascension | Senior Specialist - Technology
    ------------------------------

    Original Message


Related Content