Documentation

UpdateLoginDTO extends AbstractBaseDto

in package

• Application

implements DTOInterface

Data Transfer Object for updating an existing login (pseudonym)

Table of Contents

Interfaces

DTOInterface

Properties

$authenticationProviderId  : string|null

The authentication provider this login is associated with Can be integer ID or provider type Specify null or empty string to unassociate from known provider

$declaredUserType  : string|null

The declared intention of the user type Valid values: administrative, observer, staff, student, student_other, teacher

$integrationId  : string|null

Integration ID for the login Requires manage SIS permissions on the account Secondary identifier for complex SIS integrations

$oldPassword  : string|null

The prior password for the login Required if the caller is changing their own password

$overrideSisStickiness  : bool|null

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

$password  : string|null

The new password for the login Admins can only set password if "Password setting by admins" account setting is enabled

$sisUserId  : string|null

SIS ID for the login Requires manage SIS permissions on the account

$uniqueId  : string|null

The new unique ID for the login

$workflowState  : string|null

Used to suspend or re-activate a login Valid values: active, suspended

$apiPropertyName  : string

The name of the property in the API

Methods

__construct()  : mixed

BaseDto constructor.

getAuthenticationProviderId()  : string|null

getDeclaredUserType()  : string|null

getIntegrationId()  : string|null

getOldPassword()  : string|null

getOverrideSisStickiness()  : bool|null

getPassword()  : string|null

getSisUserId()  : string|null

getUniqueId()  : string|null

getWorkflowState()  : string|null

setAuthenticationProviderId()  : void

setDeclaredUserType()  : void

setIntegrationId()  : void

setOldPassword()  : void

setOverrideSisStickiness()  : void

setPassword()  : void

setSisUserId()  : void

setUniqueId()  : void

setWorkflowState()  : void

toApiArray()  : array<string|int, array{name: string, contents: string}>

Transform DTO properties to Canvas API multipart format

toArray()  : array<string|int, mixed>

Convert the DTO to an array

validateParameters()  : void

Validate parameters