Skip to main content
Module

x/gesso/types/params.ts>EditUserLoginParams

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

Properties

optional
loginuniqueid: string

The new unique ID for the login.

optional
loginpassword: string

The new password for the login. Can only be set by an admin user if admins are allowed to change passwords for the account.

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
loginworkflowstate: string

Allowed values: active, suspended

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

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