Accessing User Courses via API

Question

Good afternoon,

I'm trying to access user enrolled courses via the API (this is for a specified user, not the user I am authenticated as).

Using this endpoint:

https://docs.valence.desire2learn.com/res/enroll.html#get--d2l-api-lp-(version)-enrollments-users-(userId)-orgUnits-

I am receiving a 403 error, despite my scope being:

Any help is greatly appreciated.

Regards,

Daniel

Carolina.A.7123 · Answer

Hi @Daniel.G.5794,

One thing I'd suggest double-checking is the role of the target user whose enrollments you're trying to retrieve.

The route documentation notes that the results returned depend on whether the calling user can view the target user's enrollments and role within the shared org unit context.

https://docs.valence.desire2learn.com/res/enroll.html#get--d2l-api-lp-(version)-enrollments-users-(userId)-orgUnits-

When you mention:

"the account I'm testing this with is a Super Admin"

Could you clarify whether the authenticated API user is a Super Admin, or whether the user whose enrollments you're attempting to retrieve is a Super Admin?

The various Search for {roleName} permissions control a role's ability to search for enrollments belonging to users in the specified role. If the target user is enrolled in another role, it may be worth confirming that the appropriate Search for {roleName} permission is enabled as well.

I hope this helps!

Thanks,

Carolina

Daniel.G.5794 · Answer

Hi @Chris.S.534 ,

Thanks for your reply.

I've set the permissions you've mentioned above - for reference the account I'm testing this with is a Super Admin → I've then set:

I've rotated the access token, but am still receiving a 403 on this endpoint:

https://xyz.brightspace.com/d2l/api/lp/1.9/enrollments/users/211/orgUnits/

If there's anything else I can check, please let me know.

Chris.S.534 · Answer

Hi Daniel,

The scopes look good. Ensure the user making the API call has the permission required to view the target user’s enrollments and role. Check:

* Admin Tools → Roles and Permissions → Users → View User Enrollments
* Admin Tools → Roles and Permissions → Users → Search for {roleName}

See permisison details noted at the top of the community resource

https://docs.valence.desire2learn.com/res/enroll.html

Hope that helps!