User List API by using admin account

Development
1

Hi all,
Is there an API endpoint in the current release to retrieve all users by using admin account?
If not, would it be possible to add one using a plugin or extension (i.e., without making any modifications to the core platform). I’m running under Tutor if that matters.

As far as I can see, while querying as a superuser via the api, I cannot get a listing of ALL users. I can filter by username for example, but not get all. If I don’t provide a filter it defaults to my current user. One other thing I can’t see there is the ability to enrol a user in a course via the API.

Thanks

2

Hi @shav_34 - I’m not too familiar with the APIs but did you look through the user API endpoints documented here: LMS APIs — edx-platform documentation ?

Also, what are you trying to do? That might help guide advice on creating a plugin or extension.

3

Hi @sarina, Thanks for the reply. I’m trying to manage users using the REST API. Yes, I had a look at that documentation. It provides an endpoint to get users, but it requires a username or email. What I want to do is retrieve all users in the system and perform full CRUD operations — including updating passwords, etc.

4

Gotcha. I’m not sure how to do that but hopefully someone else on the forum can help.

5

Hello @shav_34,

AFAIK, there isn’t such thing available in Open edX, but you can develop your own API to manage your CRUD operations by writing a simple plugin of Open edX.

Reference link for plugin development: Getting Started With Open edX Plugin Architecture - Blog

1 Like