Skip to main content
Solved

API to get UserGroup details

  • September 8, 2025
  • 3 replies
  • 254 views
P

Hello Everyone,

We are currently developing API scripts to automate some functionalities within BeyondTrust. As part of this effort, we seek guidance on an API script that can provide comprehensive information about a user group.

We are aware of the "GET UserGroups" API, but it does not include details about assigned users, Smart groups, and enabled features. Although we know there are separate calls to retrieve this information individually, we are looking for a way to obtain all this data in a single call.

 

Thanks,

Prasad

Best answer by Neil

Hi ​@prasadp87,

 

I am not aware of a single API call which would return a BI user group with all of its members, Smart Rule access, features, etc. in one fell swoop, but here are a couple of specific options which should return the information you’re looking for:

  • Group basics: GET /UserGroups/{id}
  • Retrieve assigned users: GET /UserGroups/{id}/Users
  • Smart Rule access: GET /UserGroups/{id}/SmartRules
  • Enabled features: GET /UserGroups/{id}/Permissions

    3 replies

    N
    BeyondTrust Employee
    • Neil
    • BeyondTrust Employee
    • Answer
    • September 15, 2025

    Hi ​@prasadp87,

     

    I am not aware of a single API call which would return a BI user group with all of its members, Smart Rule access, features, etc. in one fell swoop, but here are a couple of specific options which should return the information you’re looking for:

    • Group basics: GET /UserGroups/{id}
    • Retrieve assigned users: GET /UserGroups/{id}/Users
    • Smart Rule access: GET /UserGroups/{id}/SmartRules
    • Enabled features: GET /UserGroups/{id}/Permissions
      J
      Forum|alt.badge.img+4
      • Jens Hansen
      • Guru
      • September 15, 2025

      Hey Prasad.

      It can be done in one script, but unfortunately it is not designed to be done with just one call.
      You will have to combine and use results from one call to create the other etc. to get your wanted results, but it is for sure possible to do.

      Jens

       

        P
        • prasadp87
        • Author
        • Trailblazer
        • October 4, 2025

        Thank you, Jens and Neil, for your responses. Following your suggestions, I am now working on creating a collaborative script that incorporates multiple API calls.

        Thanks,

        Prasad

          Badge Earners

          • BCA: Privileged Remote Access
            GroSanhas earned the badge BCA: Privileged Remote Access
          • Core Concepts - Privileged Remote Access
            Ahmed Butthas earned the badge Core Concepts - Privileged Remote Access
          • BCA: Password Safe
            Abdelhamid.Saberhas earned the badge BCA: Password Safe
          • BCA: Remote Support
            DQ2has earned the badge BCA: Remote Support
          • BCA: Endpoint Privilege Management - Windows
            CHRISK1has earned the badge BCA: Endpoint Privilege Management - Windows
          Show all badges
          Terms & ConditionsCookie settingsAccessibility statement