Skip to main content
Module

x/gesso/types/params.ts>CreateUserLoginParams

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

Properties

optional
userid: string

The ID of the user to create the login for.

optional
loginuniqueid: string

The unique ID for the new login.

optional
loginpassword: string

The new login's password.

optional
loginsisuserid: string

SIS ID for the login. To set this parameter, the caller must be able to manage SIS permissions on the account.

optional
loginintegrationid: string

Integration ID for the login. To set this parameter, the caller must be able to manage SIS permissions on the account. The Integration ID is a secondary identifier useful for more complex SIS integrations.

optional
loginauthenticationproviderid: string

The authentication provider this login is associated with. Logins associated with a specific provider can only be used with that provider. Legacy providers (LDAP, CAS, SAML) will search for logins associated with them, or unassociated logins. New providers will only search for logins explicitly associated with them. This can be the integer ID of the provider, or the type of the provider (in which case, it will find the first matching provider).

optional
logindeclaredusertype: string

The declared intention of the user type. This can be set, but does not change any Canvas functionality with respect to their access. A user can still be a teacher, admin, student, etc. in any particular context without regard to this setting. This can be used for administrative purposes for integrations to be able to more easily identify why the user was created. Valid values are: administrativeobserver * staff * student * student_other * teacher