Resource Description for User

Properties for User

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
authenticationToken string
authenticationTokenExpiryDatetime DateTime
authenticationType string
currentIpAddress string
deletedDisplayName string
deletedEntityType int
deletedObjectId int
email string
enabled bool
externalAdministrator ExternalAdministrator
guardian Guardian
lastAccessDatetime DateTime
passwordHash string
passwordLastChangedDatetime DateTime
staff Staff
student Student
termsAcceptedDatetime DateTime
twoFactorAuthMethod string
twoFactorDeviceIdentifier string
username string
verifiedDatetime DateTime
welcomeMessageDatetime DateTime

SDK Example for PHP

<?PHP

use Arbor\Api\Gateway\RestGateway;
use Arbor\Model\ModelBase;
use Arbor\Model\User;

ModelBase::setDefaultGateway(
    new RestGateway(
        "https://my-school.arbor.sc/rest-v2",
        "my.username@my-school.arbor.sc",
        "3bh54435v3gh45"
    )
);

$user = User::retrieve(5433);

$staff = $user->getStaff();
$student = $user->getStudent();
$guardian = $user->getGuardian();
$username = $user->getUsername();
$email = $user->getEmail();
$passwordHash = $user->getPasswordHash();
$authenticationType = $user->getAuthenticationType();
$authenticationToken = $user->getAuthenticationToken();
$authenticationTokenExpiryDatetime = $user->getAuthenticationTokenExpiryDatetime();
$currentIpAddress = $user->getCurrentIpAddress();
$lastAccessDatetime = $user->getLastAccessDatetime();
$enabled = $user->getEnabled();
$verifiedDatetime = $user->getVerifiedDatetime();
$termsAcceptedDatetime = $user->getTermsAcceptedDatetime();
$welcomeMessageDatetime = $user->getWelcomeMessageDatetime();

 

Related Resources