REST API to get members for a role

[pKadam]

I am looking to integrate our Canvas with a 3rd party access governance system using REST APIs. I cannot find an API to get the membership information for roles. I do see there is an API to get role membership per user but I am looking for an API to give me all membership data in one for or membership per role.

I don't have the same problem with group members as this API /api/v1/groups/:group_id/users gives me members per group.

[chriscas]

Hi @pKadam,

I think you may be running into a terminology/functionality issue here.  In Canvas, user accounts themselves generally do not have "roles" unless they are administrators (there is a way to pre-define a user role, but I have not seen it widely used).  Instead of the suer having roles, the user has enrollments in a course/section, and those enrollments are attached to roles.  In many cases, the roles for all of a users enrollments would be the same, but it's possible for the same user to be a student in course A and a teacher in course B.

You probably want to check out the enrollments API to see how to get the enrollment and role information back from Canvas.  Let us know if this helps at all, or if I am totally off base.

-Chris

[zwbratcher]

@chriscas  PKadam is working with API's on our canvas instance and the users he is working on is the ones that will have Admin roles at Sub Account levels. For example we have someone who is a enrollment coach that is in our Air Pilot training program. 

[chriscas]

Hi @zwbratcher and @pKadam,

Thanks for the additional context.  Unfortunately, I don't think there is a single REST API endpoint which returns a list of everyone with an "admin role x" role for all root/subaccounts (there may be something with GarphQL, but I'm not as familiar with that at this point).  As far as I know, you'd need to get a list of all of your subaccounts, then for each of those accounts, list the account admins and then look at all of the results for the specific role/roles you want to work with.

While it sounds complicated, it should really only be a few lines of code to do this.  If you have a large Canvas instance with a ton of subaccounts and/or admins, it may take a little bit to get all of the results back, but still within reason.

-Chris

[pKadam]

Thanks for the guidance, looks like https://canvas.tstc.edu/doc/api/admins.html#method.admins.index will give me all role membership information in a single API call. 

Is it safe to assume the https://canvas.tstc.edu/doc/api/roles.html#method.role_overrides.api_index API will give me both account level as well as course level Roles and "base_role_type": "AccountMembership" will help identify the account level roles? 

I read through the docs and I see no option to filter results during the API call.

[chriscas]

Hi @pKadam,

https://canvas.tstc.edu/doc/api/admins.html#method.admins.index is an account-level call, so it will only list admins for a specific account/subaccount, not all of them.  If you just add all of your admins at the root account, that would work.  If you have subaccount level admins and want to list them all, you'd need to do that call for each subaccount.

For the https://canvas.tstc.edu/doc/api/roles.html#method.role_overrides.api_index call, is seems like you could look at the "is_account_role" value in the response for  each role to determine if it's an account (admin) role vs a course role.

Some API calls have some selection/filtering parameter options, but in most cases you'll need to handle filtering on your side after getting a full list of results.

Hope this helps!

-Chris