Documentation

CreateUserDTO extends AbstractBaseDto

in package

• Application

implements DTOInterface

Table of Contents

Interfaces

DTOInterface

Properties

$authenticationProviderId  : string|null

The authentication provider this login is associated with.

$communicationAddress  : string

The communication channel address, e.g. the user’s email address.

$communicationType  : string

The communication channel type, e.g. ‘email’ or ‘sms’.

$confirmationUrl  : bool|null

Only valid for account admins. If true, returns the new user account confirmation URL in the response.

$destination  : string|null

If you’re setting the password for the newly created user, you can provide this param with a valid URL pointing into this Canvas installation, and the response will include a destination field that’s a URL that you can redirect a browser to and have the newly created user automatically logged in. The URL is only valid for a short time, and must match the domain this request is directed to, and be for a well-formed path that Canvas can recognize.

$enableSisReactivation  : bool

When true, will first try to re-activate a deleted user with matching sis_user_id if possible.

$forceSelfRegistration  : bool

Send user a self-registration style email if true.

$forceValidations  : bool|null

If true, validations are performed on the newly created user (and their associated pseudonym) even if the request is made by a privileged user like an admin. When set to false, or not included in the request parameters,any newly created users are subject to validations unless the request is made by a user with a ‘manage_user_logins’ right. In which case, certain validations such as ‘require_acceptance_of_terms’ and ‘require_presence_of_name’ are not enforced. Use this parameter to return helpful json errors while building users with an admin request.

$initialEnrollmentType  : string|null

‘observer` if doing a self-registration with a pairing code.

$integrationId  : string|null

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

$locale  : string|null

The user’s preferred language, from the list of languages Canvas supports. This is in RFC-5646 format.

$name  : string

The full name of the user. This name will be used by teacher for grading.

$pairingCode  : string|null

If provided and valid, will link the new user as an observer to the student’s whose pairing code is given.

$password  : string|null

User’s password. Cannot be set during self-registration.

$sendConfirmation  : bool

Send user notification of account creation if true. Automatically set to true during self-registration.

$shortName  : string|null

User’s name as it will be displayed in discussions, messages, and comments.

$sisUserId  : string|null

SIS ID for the user’s account. To set this parameter, the caller must be able to manage SIS permissions.

$skipConfirmation  : bool

Only valid for site admins and account admins making requests; If true, the channel is automatically validated and no confirmation email or SMS is sent.

$skipRegistration  : bool

Automatically mark the user as registered.

$sortableName  : string|null

User’s name as used to sort alphabetically in lists.

$termsOfUse  : bool

Whether the user accepts the terms of use. Required if this is a self-registration and this canvas instance requires users to accept the terms (on by default).

$timeZone  : string|null

The time zone for the user. Allowed time zones are IANA time zones or friendlier Ruby on Rails time zones.

$uniqueId  : string

User’s login ID. If this is a self-registration, it must be a valid email address.

$apiPropertyName  : string

The name of the property in the API

Methods

__construct()  : mixed

BaseDto constructor.

getAuthenticationProviderId()  : string|null

getCommunicationAddress()  : string

getCommunicationType()  : string

getConfirmationUrl()  : bool|null

getDestination()  : string|null

getForceValidations()  : bool|null

getInitialEnrollmentType()  : string|null

getIntegrationId()  : string|null

getLocale()  : string|null

getName()  : string

getPairingCode()  : string|null

getPassword()  : string|null

getShortName()  : string|null

getSisUserId()  : string|null

getSortableName()  : string|null

getTimeZone()  : string|null

getUniqueId()  : string

isEnableSisReactivation()  : bool

isForceSelfRegistration()  : bool

isSendConfirmation()  : bool

isSkipConfirmation()  : bool

isSkipRegistration()  : bool

isTermsOfUse()  : bool

setAuthenticationProviderId()  : void

setCommunicationAddress()  : void

setCommunicationType()  : void

setConfirmationUrl()  : void

setDestination()  : void

setEnableSisReactivation()  : void

setForceSelfRegistration()  : void

setForceValidations()  : void

setInitialEnrollmentType()  : void

setIntegrationId()  : void

setLocale()  : void

setName()  : void

setPairingCode()  : void

setPassword()  : void

setSendConfirmation()  : void

setShortName()  : void

setSisUserId()  : void

setSkipConfirmation()  : void

setSkipRegistration()  : void

setSortableName()  : void

setTermsOfUse()  : void

setTimeZone()  : void

setUniqueId()  : void

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

Convert the DTO to an array for API requests

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

Convert the DTO to an array