How to Retrieve the List of User details for a Specific Group using REST API

Groups are collections of users to which permissions can be assigned. This article provides comprehensive guidance on how to retrieve the list of user details for a specific group via REST API.

Authorization

To execute this action, please ensure that an access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Then add the token generated from the ‘token’ endpoint above in the Headers with key as ‘Authorization’ and value as ‘bearer {Your_token}’

Self-Hosted Server

For self-hosted instances, use the following endpoint:

https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/groups/{id}/users

Bold BI Cloud Server

For Bold BI Cloud instances, the endpoint is:

https://{yourdomain}/bi/api/v5.0/groups/{id}/users

Request Type

• GET: This request type is used to retrieve the list of groups.

Example Request

Here is an example of how to structure your GET request:

For more information on managing groups, please refer to this documentation.

Responses

• 200: List of group’s users has been retrieved successfully.
• 204: User list is empty.
• 400: Page does not exist.
• 401: Access denied.
• 404: Group detail was not found.
• 405: Request type was not GET.
• 406: Invalid Group ID.
• 417: Failed to check whether the group is active or not.

Reference

• How to get the list of users using REST API.
• How to Remove a User from a Group using Bold BI REST API.
• How to retrieve the list of categories in the dashboard listing page via REST API.