Solved

API to get UserGroup details

Forum|Forum|5 months ago
September 8, 2025
5 replies
318 views

prasadp87
Trailblazer

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

N

Neil
BeyondTrust Employee
Answer
Forum|Forum|5 months ago
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

Like

J

+4

Jens Hansen
Guru
Forum|Forum|5 months ago
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

Like

P

prasadp87
Author
Trailblazer
Forum|Forum|5 months ago
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

Like

N

+4

NectarNinja
Apprentice
Forum|Forum|22 days ago
February 12, 2026

Hi everybody! hope y’all are doing great.

We’re kinda lost. We’re trying to do a [GET] Call to a Cloud Instance asking for →

Retrieve assigned users: GET /UserGroups/{id}/Users

Whenever we try to send it, we get the error “User not authenticated”.

We’re raelly new to the API usage. so far we’’ve created:

An API Registration with 0 Rule options, pointing to any IP (0.0.0.0/0) (we got an API KEY)
Local User group with the API created
Local User assigned to the Local Group

We’re using Postman. Is there any step by step guide? I’ve skimmed through the guides, but so far we wernt able to get a response with the info we need.

Kind regards.