Skip to main content
Module

x/gesso/types/params.ts>ListUsersInAccountParams

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

Properties

optional
searchterm: string

The partial name or full ID of the users to match and return in the results list. Must be at least 3 characters. Note that the API will prefer matching on canonical user ID if the ID has a numeric form. It will only search against other fields if non-numeric in form, or if the numeric value doesn't yield any matches. Queries by administrative users will search on SIS ID, login ID, name, or email address

optional
enrollmenttype: string

When set, only return users enrolled with the specified course-level base role. This can be a base role type of 'student', 'teacher', 'ta', 'observer', or 'designer'.

optional
sort: string

Allowed values: username, email, sis_id, last_login

optional
order: string

Allowed values: asc, desc