REST.Backend.EMSApi.TEMSClientAPI.AddUser

From RAD Studio API Documentation
Jump to: navigation, search

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

EEMSClientAPIError

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