nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Canvas API call to return all Account Roles

RobertLms

Believe that /v1/accounts/{account_id}/permissions only returns all the Course Roles (NOT the Account Roles)

How to use Canvas API to return all Account Roles?

Find more posts tagged with

Accepted answers

RobertLms

Thank You Chris for a solution: First, return all Account Settings for a particular account (/accounts/{account_id}/settings) and then loop to filter out the ones that have "is_account_role":true

All comments

Chris

Hi @RobertLms,

Just for clarity here... Are you trying to get a list of all roles (Teacher, TA, Admin) available in a Canvas account, or are you trying to determine what permissions a specific user has available to them with their current roles? While these two things are related, they are completely different API calls, so it'll helpful to know which you need to do to give further explanation.

-Chris

RobertLms

Also, What API to use to return a list of All Account Settings (in the UI) for a particular account?

Does one need to use pagination for accounts/{account_id}/settings?

implementation notes state: Returns a JSON object containing a subset of settings for the specified account.

reynlds

How about a Provisioning Report? It'll return account roles assigned to each sub-account, but it'll come back in a CSV format.

RobertLms

Thank You Chris for a solution: First, return all Account Settings for a particular account (/accounts/{account_id}/settings) and then loop to filter out the ones that have "is_account_role":true

Unanswered Questions

Requirements for a Developer API key
Hello, I'm building a standalone app that integrate with CanvasI) - What are the requirements (and cost if any) for receiving an API developer key issued by Instructure? - Are Instructure-issued keys enabled globally in all Canvas organizations? or will there need to be institution-by-institution enablement? Thanks
Discrepancy between Canvas UI and Server Logs (500/503 Errors)
Hi everyone, I am seeking some insight into how Canvas LMS handles HTTP errors and how they are reflected in the logs versus the user interface. We are currently observing the following behavior in our environment: Log-only errors: We are seeing 500 (Internal Server Error) and 503 (Service Unavailable) errors recorded in…
Why is the Activity.id.history Variable Empty in My LTI Integration?
I'm currently integrating an LTI tool and attempting to use the Activity.id.history https://canvas.instructure.com/doc/api/file.tools_variable_substitutions.html#activity-id-history variable, but I'm experiencing issues getting it to work properly. What I've Done: Added the Activity.id.history variable to my Developer…
LTI Variable substitution for Term SIS ID?
I looked through the LTI Variable Substitutions documentation and while there are variable substitutions available for Canvas.term.name and Canvas.term.id (which is the Canvas incremented ID like "104"), I was surprised to see there was no option for Canvas.term.sisSourceId I tried testing other possible variants that may…
Learning Mastery Gradebook: assign_outcome_order API Returns Success But Doesn't Persist Column Order
Summary:The Learning Mastery Gradebook allows drag-and-drop reordering of outcome columns, and this triggers a call to /api/v1/courses/:course_id/assign_outcome_order. The API returns 204 No Content (success), but the column order does not persist after page refresh. Steps to Reproduce: Open Learning Mastery Gradebook for…