Postman API to get full users list or other details

Sherry.Sin56 · November 2022

My role is super admin in the instance. I was doing API call to get information using Postman. While I was trying to get all users, I got the list through e.g. /lp/{{lpversion}}/users/. However I didnt get the full list. If I search by /lp/{{lpversion}}/users/[nnn], I got the user info. Is there any particular extra permission is required for the role? The same applies to while I was trying to get all orgunitid, I ran /d2l/api/lp/{{lpversion}}/organization/info and the result is blank with 404 status.

Shah.Sarker42 · November 2022

Hi @Sherry Sin ,

These API calls are not designed to retrieve all users, therefore this is expected behaviour. I do not believe you need any additional permissions.

Same with the other API call, that is designed to retrieve the root level Org only.

It appears that you are trying to download all user and OrgUnit data. Have you checked Users and Organizational Units data sets. These data sets are accessible via "Data Access> Data Hub" menu. I have included the corresponding documentation link:

https://documentation.brightspace.com/EN/insights/data_hub/admin/bds_users.htm?Highlight=users%20data%20set#Brightspace_Data_Set:_Users

https://documentation.brightspace.com/EN/insights/data_hub/admin/bds_org_units.htm?Highlight=Organizational%20Units%20data%20set#Brightspace_Data_Set:_Org_Units

Hope this helps.

Postman API to get full users list or other details

Answers

Categories