Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/gesso/types/params.ts>UpdateRoleParams

A TypeScript API client for Canvas LMS
Peekoe/Gesso
Latest
interface UpdateRoleParams
import { type UpdateRoleParams } from "https://deno.land/x/gesso@v0.1.2/types/params.ts";

Properties

optional
label: string

The label for the role. Can only change the label of a custom role that belongs directly to the account.

optional
permissionsXexplicit: boolean

no description

optional
permissionsXenabled: boolean

These arguments are described in the documentation for the add_role method.

optional
permissionsXappliestoself: boolean

If the value is 1, permission applies to the account this role is in. The default value is 1. Must be true if applies_to_descendants is false. This value is only returned if enabled is true.

optional
permissionsXappliestodescendants: boolean

If the value is 1, permission cascades down to sub accounts of the account this role is in. The default value is 1. Must be true if applies_to_self is false.This value is only returned if enabled is true.