canvas roles create

canvas roles create

Create a new role

Synopsis

Create a new custom role in the specified account.

Examples:

canvas roles create --account-id 1 --label "Custom Teacher" --base-type TeacherEnrollment

canvas roles create [flags]

Options

      --account-id int     Account ID (required)
      --base-type string   Base role type (AccountMembership, StudentEnrollment, TeacherEnrollment, TaEnrollment, ObserverEnrollment, DesignerEnrollment)
  -h, --help               help for create
      --label string       Role label (required)

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 roles - Manage account roles

Auto generated by spf13/cobra on 25-Jan-2026