...
ID* | string The identifer by which the user is referenced for hotelkit |
clientID* | ClientIDstring The identifer of the user from the partner. Will be used to reassure the correct connection of the user between hotelkit and the partner. |
givenName* | string The given name of a user |
surName* | string The surname of a given user |
loginName | string A identifer that the user needs to login. It should only be set if the partner enables SSO to make sure the user has the same authentication as on the identity provider |
titlePrefix | string a title that is prefixed to the name of a User |
titleSuffix | string a title that is suffixed to the name of a User |
birthDate | string($date) birthday of the user as 'dd.mm.YYYY' |
string($email) professional e-mail address of this user. | |
gender | string The gender of a user. Will be used for configure shown text accordingly. Enum: |
customerList* | example: List [ "demo1", "demo2" ] list of customer-keys in which the user should be active. If attribute is not given the user will only be available in the current customer. string |
position | string position within a department |
department | string the department of a user. Can be used for granting access within hotelkit. |
roles | example: List [ "HOD", "Food & Beverage" ] specific roles of the user. could be used for access-management. The list of used roles should be negotiated with hotelkit. string |
telephone | string professional telephone availability |
startDate | string($date) start of employment as 'dd.mm.yyyy' |
personnelNumber | string A roster identification number. Will be used for presentation only. |
...
A user is not listed as soon as he has no access to the customer anymore. Additionally, the customer can flag a user specifically as a user who is not available for the partner.
Deactivating a User
If a user gets deactivated in the partner (access is revoked) this change shall reflect in hotelkit by updating the user via PUT /users/{ID} and setting the attribute customerList to be empty “customerList”:”[]”
Pagination
With API version 3.1 we provide pagination for user listing, which returns a subset of users.
...