CreateLoginDTO
extends AbstractBaseDto
in package
implements
DTOInterface
Data Transfer Object for creating a new login (pseudonym)
Table of Contents
Interfaces
Properties
- $authenticationProviderId : string|null
- The authentication provider this login is associated with Can be integer ID or provider type
- $declaredUserType : string|null
- The declared intention of the user type Valid values: administrative, observer, staff, student, student_other, teacher
- $existingIntegrationId : string|null
- An Integration ID to identify a user in a trusted account (non-OSS Canvas) Alternative to userId, existingUserId, or existingSisUserId
- $existingSisUserId : string|null
- An SIS User ID to identify a user in a trusted account (non-OSS Canvas) Alternative to userId, existingUserId, or existingIntegrationId
- $existingUserId : string|null
- A Canvas User ID to identify a user in a trusted account (non-OSS Canvas) Alternative to userId, existingSisUserId, or existingIntegrationId
- $integrationId : string|null
- Integration ID for the login Requires manage SIS permissions on the account Secondary identifier for complex SIS integrations
- $password : string|null
- The new login's password
- $sisUserId : string|null
- SIS ID for the login Requires manage SIS permissions on the account
- $trustedAccount : string|null
- The domain of the account to search for the user (non-OSS Canvas) Required when identifying a user in a trusted account
- $uniqueId : string|null
- The unique ID for the new login (required)
- $userId : int|null
- The ID of the user to create the login for (required)
- $apiPropertyName : string
- The name of the property in the API
Methods
- __construct() : mixed
- BaseDto constructor.
- getAuthenticationProviderId() : string|null
- getDeclaredUserType() : string|null
- getExistingIntegrationId() : string|null
- getExistingSisUserId() : string|null
- getExistingUserId() : string|null
- getIntegrationId() : string|null
- getPassword() : string|null
- getSisUserId() : string|null
- getTrustedAccount() : string|null
- getUniqueId() : string|null
- getUserId() : int|null
- setAuthenticationProviderId() : void
- setDeclaredUserType() : void
- setExistingIntegrationId() : void
- setExistingSisUserId() : void
- setExistingUserId() : void
- setIntegrationId() : void
- setPassword() : void
- setSisUserId() : void
- setTrustedAccount() : void
- setUniqueId() : void
- setUserId() : 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
- validateUserIdentification() : void
- Validate that only one user identification method is provided
Properties
$authenticationProviderId
The authentication provider this login is associated with Can be integer ID or provider type
public
string|null
$authenticationProviderId
= null
$declaredUserType
The declared intention of the user type Valid values: administrative, observer, staff, student, student_other, teacher
public
string|null
$declaredUserType
= null
$existingIntegrationId
An Integration ID to identify a user in a trusted account (non-OSS Canvas) Alternative to userId, existingUserId, or existingSisUserId
public
string|null
$existingIntegrationId
= null
$existingSisUserId
An SIS User ID to identify a user in a trusted account (non-OSS Canvas) Alternative to userId, existingUserId, or existingIntegrationId
public
string|null
$existingSisUserId
= null
$existingUserId
A Canvas User ID to identify a user in a trusted account (non-OSS Canvas) Alternative to userId, existingSisUserId, or existingIntegrationId
public
string|null
$existingUserId
= null
$integrationId
Integration ID for the login Requires manage SIS permissions on the account Secondary identifier for complex SIS integrations
public
string|null
$integrationId
= null
$password
The new login's password
public
string|null
$password
= null
$sisUserId
SIS ID for the login Requires manage SIS permissions on the account
public
string|null
$sisUserId
= null
$trustedAccount
The domain of the account to search for the user (non-OSS Canvas) Required when identifying a user in a trusted account
public
string|null
$trustedAccount
= null
$uniqueId
The unique ID for the new login (required)
public
string|null
$uniqueId
= null
$userId
The ID of the user to create the login for (required)
public
int|null
$userId
= null
$apiPropertyName
The name of the property in the API
protected
string
$apiPropertyName
= ''
Methods
__construct()
BaseDto constructor.
public
__construct(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Tags
getAuthenticationProviderId()
public
getAuthenticationProviderId() : string|null
Return values
string|nullgetDeclaredUserType()
public
getDeclaredUserType() : string|null
Return values
string|nullgetExistingIntegrationId()
public
getExistingIntegrationId() : string|null
Return values
string|nullgetExistingSisUserId()
public
getExistingSisUserId() : string|null
Return values
string|nullgetExistingUserId()
public
getExistingUserId() : string|null
Return values
string|nullgetIntegrationId()
public
getIntegrationId() : string|null
Return values
string|nullgetPassword()
public
getPassword() : string|null
Return values
string|nullgetSisUserId()
public
getSisUserId() : string|null
Return values
string|nullgetTrustedAccount()
public
getTrustedAccount() : string|null
Return values
string|nullgetUniqueId()
public
getUniqueId() : string|null
Return values
string|nullgetUserId()
public
getUserId() : int|null
Return values
int|nullsetAuthenticationProviderId()
public
setAuthenticationProviderId(string|null $authenticationProviderId) : void
Parameters
- $authenticationProviderId : string|null
setDeclaredUserType()
public
setDeclaredUserType(string|null $declaredUserType) : void
Parameters
- $declaredUserType : string|null
setExistingIntegrationId()
public
setExistingIntegrationId(string|null $existingIntegrationId) : void
Parameters
- $existingIntegrationId : string|null
setExistingSisUserId()
public
setExistingSisUserId(string|null $existingSisUserId) : void
Parameters
- $existingSisUserId : string|null
setExistingUserId()
public
setExistingUserId(string|null $existingUserId) : void
Parameters
- $existingUserId : string|null
setIntegrationId()
public
setIntegrationId(string|null $integrationId) : void
Parameters
- $integrationId : string|null
setPassword()
public
setPassword(string|null $password) : void
Parameters
- $password : string|null
setSisUserId()
public
setSisUserId(string|null $sisUserId) : void
Parameters
- $sisUserId : string|null
setTrustedAccount()
public
setTrustedAccount(string|null $trustedAccount) : void
Parameters
- $trustedAccount : string|null
setUniqueId()
public
setUniqueId(string|null $uniqueId) : void
Parameters
- $uniqueId : string|null
setUserId()
public
setUserId(int|null $userId) : void
Parameters
- $userId : int|null
toApiArray()
Transform DTO properties to Canvas API multipart format
public
toApiArray() : array<string|int, array{name: string, contents: string}>
Return values
array<string|int, array{name: string, contents: string}>toArray()
Convert the DTO to an array
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>validateUserIdentification()
Validate that only one user identification method is provided
private
validateUserIdentification() : void