canvas roles
canvas roles¶
Manage account roles
Synopsis¶
Manage Canvas account roles.
Roles define sets of permissions that can be assigned to users. Canvas has built-in roles and allows custom roles.
Base role types: - AccountMembership - StudentEnrollment - TeacherEnrollment - TaEnrollment - ObserverEnrollment - DesignerEnrollment
Examples:
canvas roles list --account-id 1
canvas roles get 123 --account-id 1
canvas roles create --account-id 1 --label "Custom Teacher" --base-type TeacherEnrollment
Options¶
Options inherited from parent commands¶
--as-user int Masquerade as another user (admin feature, requires permission)
--columns strings Select specific columns to display (comma-separated)
--config string config file (default is $HOME/.canvas-cli/config.yaml)
--dry-run Print curl commands instead of executing requests
--filter string Filter results by text (case-insensitive substring match)
--instance string Canvas instance URL (overrides config)
--limit int Limit number of results for list operations (0 = unlimited)
--no-cache Disable caching of API responses
-o, --output string Output format: table, json, yaml, csv (default "table")
--show-token Show actual token in dry-run output (default: redacted)
--sort string Sort results by field (prefix with - for descending, e.g., -name)
-v, --verbose Enable verbose output
SEE ALSO¶
- canvas - Canvas LMS CLI - Interact with Canvas from the command line
- canvas roles activate - Activate a role
- canvas roles create - Create a new role
- canvas roles deactivate - Deactivate a role
- canvas roles get - Get details for a specific role
- canvas roles list - List roles for an account
- canvas roles update - Update an existing role