REST.Backend.EMSApi.TEMSClientAPI.AddUser
Delphi
procedure AddUser(const AUserName, APassword: string;
const AUserFields: TJSONObject; out AUser: TUser);
C++
void __fastcall AddUser(const System::UnicodeString AUserName, const System::UnicodeString APassword, System::Json::TJSONObject* const AUserFields, /* out */ TUser &AUser);
Properties
Type | Visibility | Source | Unit | Parent |
---|---|---|---|---|
procedure function |
public | REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp |
REST.Backend.EMSApi | TEMSClientAPI |
Description
Adds to the EMS server a user with the specified username, password and additional data.
AddUser receives the following parameters:
AUserName
is the username of the new user.APassword
is the password of the new user.AUserFields
is an optional JSON object that contains additional data for the new user.AUser
is an instance of TUser that represents the new user.
Exceptions
Exception | Message | Description |
---|---|---|
MasterSecret required |
Authentication is TAuthentication.MasterSecret and ConnectionInfo.MasterSecret is an empty string. | |
Session token required |
Authentication is TAuthentication.Session and you did not log in or the session authentication token that you provided to Login is an empty string. |
See Also
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
- REST.Backend.EMSApi.TEMSClientAPI.UpdateUser
- REST.Backend.EMSApi.TEMSClientAPI.QueryUserName
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersNames
- REST.Backend.EMSApi.TEMSClientAPI.RetrieveUsersFields
- REST.Backend.EMSApi.TEMSClientAPI.QueryUsers
- REST.Backend.EMSApi.TEMSClientAPI.SignupUser
- REST.Backend.EMSApi.TEMSClientAPI.LoginUser
- REST.Backend.EMSApi.TEMSClientAPI.LogoutUser
- REST.Backend.EMSApi.TEMSClientAPI.DeleteUser
- REST.Backend.EMSApi.TEMSClientAPI.AddUsersToGroup
- REST.Backend.EMSApi.TEMSClientAPI.RemoveUsersFromGroup