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

x/gesso/types/params.ts>UpdateAnAccountParams

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

Properties

optional
accountname: string

Updates the account name

optional
accountsisaccountid: string

Updates the account sis_account_id Must have manage_sis permission and must not be a root_account.

optional
accountdefaulttimezone: string

The default time zone of the account. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

optional
accountdefaultstoragequotamb: number

The default course storage quota to be used, if not otherwise specified.

optional
accountdefaultuserstoragequotamb: number

The default user storage quota to be used, if not otherwise specified.

optional
accountdefaultgroupstoragequotamb: number

The default group storage quota to be used, if not otherwise specified.

optional
accountcoursetemplateid: number

The ID of a course to be used as a template for all newly created courses. Empty means to inherit the setting from parent account, 0 means to not use a template even if a parent account has one set. The course must be marked as a template.

optional
accountsettingsrestrictstudentpastviewvalue: boolean

Restrict students from viewing courses after end date

optional
accountsettingsrestrictstudentpastviewlocked: boolean

Lock this setting for sub-accounts and courses

optional
accountsettingsrestrictstudentfutureviewvalue: boolean

Restrict students from viewing courses before start date

optional
accountsettingsmicrosoftsyncenabled: boolean

Determines whether this account has Microsoft Teams Sync enabled or not. Note that if you are altering Microsoft Teams sync settings you must enable the Microsoft Group enrollment syncing feature flag. In addition, if you are enabling Microsoft Teams sync, you must also specify a tenant, login attribute, and a remote attribute. Specifying a suffix to use is optional.

optional
accountsettingsmicrosoftsynctenant: string

The tenant this account should use when using Microsoft Teams Sync. This should be an Azure Active Directory domain name.

optional
accountsettingsmicrosoftsyncloginattribute: string

The attribute this account should use to lookup users when using Microsoft Teams Sync. Must be one of “sub”, “email”, “oid”, “preferred_username”, or “integration_id”.

optional
accountsettingsmicrosoftsyncloginattributesuffix: string

A suffix that will be appended to the result of the login attribute when associating Canvas users with Microsoft users. Must be under 255 characters and contain no whitespace. This field is optional.

optional
accountsettingsmicrosoftsyncremoteattribute: string

The Active Directory attribute to use when associating Canvas users with Microsoft users. Must be one of “mail”, “mailNickname”, or “userPrincipalName”.

optional
accountsettingsrestrictstudentfutureviewlocked: boolean

Lock this setting for sub-accounts and courses

optional
accountsettingslockallannouncementsvalue: boolean

Disable comments on announcements

optional
accountsettingslockallannouncementslocked: boolean

Lock this setting for sub-accounts and courses

optional
accountsettingsusagerightsrequiredvalue: boolean

Copyright and license information must be provided for files before they are published.

optional
accountsettingsusagerightsrequiredlocked: boolean

Lock this setting for sub-accounts and courses

optional
accountsettingsrestrictstudentfuturelistingvalue: boolean

Restrict students from viewing future enrollments in course list

optional
accountsettingsrestrictstudentfuturelistinglocked: boolean

Lock this setting for sub-accounts and courses

optional
accountsettingsconditionalreleasevalue: boolean

Enable or disable individual learning paths for students based on assessment

optional
accountsettingsconditionalreleaselocked: boolean

Lock this setting for sub-accounts and courses

optional
overridesisstickiness: boolean

Default is true. If false, any fields containing “sticky” changes will not be updated. See SIS CSV Format documentation for information on which fields can have SIS stickiness

optional
accountsettingslockoutcomeproficiencyvalue: boolean

DEPRECATED Restrict instructors from changing mastery scale

optional
accountlockoutcomeproficiencylocked: boolean

DEPRECATED Lock this setting for sub-accounts and courses

optional
accountsettingslockproficiencycalculationvalue: boolean

DEPRECATED Restrict instructors from changing proficiency calculation method

optional
accountlockproficiencycalculationlocked: boolean

DEPRECATED Lock this setting for sub-accounts and courses

optional
accountservices: unknown

Give this a set of keys and boolean values to enable or disable services matching the keys