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

x/gesso/types/params.ts>ListUsersInCourseParams

A TypeScript API client for Canvas LMS
Latest
interface ListUsersInCourseParams
import { type ListUsersInCourseParams } 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.

optional
sort: string

Allowed values: username, last_login, email, sis_id

optional
enrollment_type: string[]

Allowed values: teacher, student, student_view, ta, observer, designer

optional
enrollmentrole: string

Deprecated When set, only return users enrolled with the specified course-level role. This can be a role created with the Add Role API or a base role type of 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.

optional
enrollmentroleid: number

When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the Add Role API or a built_in role id with type 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'ObserverEnrollment', or 'DesignerEnrollment'.

optional
include: string[]

Allowed values: enrollments, locked, avatar_url, test_student, bio, custom_links, current_grading_period_scores, uuid

optional
userid: string

If this parameter is given and it corresponds to a user in the course, the page parameter will be ignored and the page containing the specified user will be returned instead.

optional
user_ids: number[]

If included, the course users set will only include users with IDs specified by the param. Note: this will not work in conjunction with the “user_id” argument but multiple user_ids can be included.

optional
enrollment_state: string[]

Allowed values: active, invited, rejected, completed, inactive