Name | Description | Type | Additional information |
---|---|---|---|
UserId |
Required: The PK of the existing User that you want to update. |
globally unique identifier |
None. |
UserUpdatingOptions |
Optional flags for the UpdateUser call |
UserUpdatingOptions |
None. |
FirstName |
Required: The User's first/given name. Max Length = 60 |
string |
Required Max length: 60 |
LastName |
Required: The User's last name / surname. Max Length = 60 |
string |
Required Max length: 60 |
MiddleInitial |
Optional: The User's middle initial. Max Length = 2 |
string |
Max length: 2 |
Nickname |
Represents the User's nickname |
string |
None. |
sGenderId |
Optional: 1=Female, 2=Male, 3=Unspecified |
integer |
None. |
DefaultFloorId |
Optional: Usually the Floor that the person's desk/primary workplace is on. |
globally unique identifier |
None. |
DefaultFloorStopId |
Optional: Default Floor Stop in elevator that the person will go to when using Destination elevator systems. |
integer |
None. |
FacilityId |
Required: PK of the facility that the User is located in. Retrieve possible values by calling /Facility/GetAllFacilities |
globally unique identifier |
Required |
CompanyInstanceType |
Required: The type of company instance that the User belongs to - 1 = Occupancy, 2 = Vendor, 3 = System Owner, 4 = Integrator |
integer |
Required |
CompanyInstanceId |
Required: The PK of the company instance the User will be assigned to. Retrieve this by calling /Occupancy/GetAllOccupancies, /Vendor/GetAllVendors, /SystemOwner/GetAllOwners, or Integrator/GetAllIntegrators based on the CompanyInstanceType. |
globally unique identifier |
Required |
ACSystemId |
Required: The PK of the Access Control System the User will be assigned to. Retrieve this by calling /ACSystem/GetAllSystems |
globally unique identifier |
Required |
StartDatetime |
Optional: The DateTime when the record will start to be valid. If null, the record will be active immediately. |
date |
None. |
EndDatetime |
Optional: The DateTime when the record will stop being valid. If null, the record will be active indefinitely. |
date |
None. |
AccessRightsSuspended |
Required: Whether or not the User's Access Rights are suspended |
boolean |
None. |
AccessRightsSuspendedStart |
Optional: The DateTime when the User's Access Rights will become suspended. If null and AccessRightsSuspended is true, all access will be suspended immediately. |
date |
None. |
AccessRightsSuspendedEnd |
Optional: The DateTime when the User's Access Rights will stop being suspended. If null and AccessRightsSuspended is true, access will be suspended indefinitely. |
date |
None. |
WebSiteRightsSuspended |
Required: Whether or not the User's BluSKY login is suspended |
boolean |
None. |
WebSiteRightsSuspendedStart |
Optional: The DateTime when the User's BluSKY login will become suspended. If null and WebSiteRightsSuspended is true, all BluSKY access will be suspended immediately. |
date |
None. |
WebSiteRightsSuspendedEnd |
Optional: The DateTime when the User's BluSKY login will become suspended. If null and WebSiteRightsSuspended is true, all BluSKY access will be suspended immediately. |
date |
None. |
BadgeTemplateId |
Optional: The PK of the Badge Template assinged to the User. Retrieve this by calling /Badges/GetAllBadges |
globally unique identifier |
None. |
EmployeeNumber |
Optional: The employee number assigned to the User (typically by their HR department) |
string |
None. |
HasLoginRights |
Required: Whether or not the User should have a login and password |
boolean |
None. |
Login |
Conditional: Required if HasLoginRights is true |
string |
None. |
Password |
Conditional: Required if HasLoginRights is true |
string |
None. |
GenerateWelcomeMessage |
Optional: True to send a welcome email message |
boolean |
None. |
Deleted |
Optional: True to create/update User as deleted |
boolean |
None. |
JobTitle |
Optional: Job Title |
string |
None. |
OccupancyName |
Represents an Occupancy a User belongs to. If specified, ACSystemId and FacilityId can be omited as well as a CompanyInstanceId when CompanyInstanceType = 1 |
string |
None. |
UserUDFValueViewModels |
Optional : User Defined Values while creating a new user in BluSky |
Collection of UserUDFValueViewModel |
None. |
DepartmentName |
Optional : The name of the department the person belgons to |
string |
None. |
DepartmentCode |
Optional : The Code of the department the person belgons to |
string |
None. |
PronounId |
Optional : The pronoun the person needs to be called as. Example : He/Him/His Or They/Them/Theirs She/Her/Hers Or They/Them/Theirs She/Her/Hers He/Him/His They/Them/Theirs To Fetch Pronouns : api/v1/Pronouns |
globally unique identifier |
None. |
WorkEnvironmentTypeId |
Optional : Determines the Employment Type of the person, Example : Full time Remote, Hybrid etc. To Fetch WorkEnvironmentType : api/v1/WorkEnvironmentTypes |
globally unique identifier |
None. |
EmploymentTermId |
Optional : Determines whether the employment is Permenent or temporary |
EmploymentTerm |
None. |
WorkerTypeId |
Optional : Determines the type of work the person is going to be doing, example : Consultant, Contractor etc.. |
WorkerType |
None. |
OfficeDeskLocation |
Determines the location of the office desk |
string |
None. |
EmergencyContactName |
Determines the Name of the Person, whose contact is given as Emergency Contact. |
string |
None. |
EmergencyContactRelationship |
Determines the Relationship of the Person with user, whose contact is given as Emergency Contact. |
string |
None. |
EmergencyContactHomePhone |
Determines the Emergency Contact(Home) for a given user |
string |
None. |
EmergencyContactWorkPhone |
Determines the Emergency Contact(Work) for a given user |
string |
None. |
EmergencyContactMobilePhone |
Determines the Emergency Contact(Mobile) for a given user |
string |
None. |