Skip to main content
Module

x/gesso/types/params.ts>ListGroupMembershipsParams

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

Properties

optional
filter_states: string[]

Allowed values: accepted, invited, requested

optional
rlid: string

If specified only NamesAndRoleMemberships with access to the LTI link references by this rlid will be included. Also causes the member array to be included for each returned NamesAndRoleMembership. If the role parameter is also present, it will be 'and-ed' together with this parameter

optional
role: string

If specified only NamesAndRoleMemberships having this role in the given Group will be included. Value must be a fully-qualified LTI/LIS role URN. Further, only purl.imsglobal.org/vocab/lis/v2/membership#Member and purl.imsglobal.org/vocab/lis/v2/membership#Manager are supported. If the rlid parameter is also present, it will be 'and-ed' together with this parameter

optional
limit: string

May be used to limit the number of NamesAndRoleMemberships returned in a page. Defaults to 50.