Users Service
Allow to search, add and modify users.
Access to this service is restricted.
The following operations are supported. For a formal definition, please review the Service Description.
-
AddUser
Adds a new user in the system.Input message User Container element for the user to be inserted. Id Unused, leave empty. Username The unique user name. Firstname First name. Middlename Middle name. Lastname Last name. Password Password. EMail EMail address. Lang User predefined language and culture code (example: "en-US"). Organization Free string that defines user organization. ExternalId Free string that can contains an external user identifier. Gender The gender of the user. - Undefined
- Male
- Female
Birthday Birthday. Street Address street name. Locality Address locality name. Region Address region name. Country Address country name. PCode Address postal code. PhoneNumber User phone number. Qualification Free string for user qualification. Status Status of the user: true if the user is enabled for login, false otherwise. Output message UserId The unique numeric identifier assigned to the user. -
FindUser
Search users in the system.
The search is performed on the username field.Input message SearchValue Substring to search. Output message User Container element for result items. Id The unique numeric user identifier. Username The unique user name. Firstname First name. Middlename Middle name. Lastname Last name. Password Password. EMail EMail address. Lang User predefined language and culture code (example: "en-US"). Organization Free string that defines user organization. ExternalId Free string that can contains an external user identifier. Gender The gender of the user. - Undefined
- Male
- Female
Birthday Birthday. Street Address street name. Locality Address locality name. Region Address region name. Country Address country name. PCode Address postal code. PhoneNumber User phone number. Qualification Free string for user qualification. Status Status of the user: true if the user is enabled for login, false otherwise. -
ModifyUser
Modifies an existing user.Input message User Container element for the user to be inserted. Id Unused, leave empty. Username The unique user name. Firstname First name. Middlename Middle name. Lastname Last name. Password Password. EMail EMail address. Lang User predefined language and culture code (example: "en-US"). Organization Free string that defines user organization. ExternalId Free string that can contains an external user identifier. Gender The gender of the user. - Undefined
- Male
- Female
Birthday Birthday. Street Address street name. Locality Address locality name. Region Address region name. Country Address country name. PCode Address postal code. PhoneNumber User phone number. Qualification Free string for user qualification. Status Status of the user: true if the user is enabled for login, false otherwise. -
RemoveUser
Removes an user from the system.Input message Username The unique username.