REST.Backend.EMSApi.TEMSClientAPI.UpdateUser

• Up to Parent: TEMSClientAPI

Delphi

procedure UpdateUser(const AObjectID: string;  const AUserObject: TJSONObject; out AUpdatedAt: TUpdatedAt); overload;
procedure UpdateUser(const AUser: TUser; const AUserObject: TJSONObject;  out AUpdatedAt: TUpdatedAt); overload;

C++

void __fastcall UpdateUser(const System::UnicodeString AObjectID, System::Json::TJSONObject* const AUserObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;
void __fastcall UpdateUser(const TUser &AUser, System::Json::TJSONObject* const AUserObject, /* out */ TUpdatedAt &AUpdatedAt)/* overload */;

Properties

Type	Visibility	Source	Unit	Parent
procedure function	public	REST.Backend.EMSApi.pas REST.Backend.EMSApi.hpp	REST.Backend.EMSApi	TEMSClientAPI

Description

Replaces the existing information about the specified user with the specified information.

UpdateUser receives the following parameters:

• The target user, either as a string with the ID of the user (AObjectID) or as an instance of TUser (AUser).
• AUserObject is a JSON object that contains the new data for the target user.
• AUpdatedAt is an instance of TUpdatedAt that UpdateUser fills with the date and time when the EMS Server applied the requested change.

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

• REST.Backend.EMSApi.TEMSClientAPI.AddUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveUser
• REST.Backend.EMSApi.TEMSClientAPI.RetrieveCurrentUser
• 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

• REST.Backend.EMSApi.TEMSClientAPI.UpdateGroup
• REST.Backend.EMSApi.TEMSClientAPI.UpdateModule
• REST.Backend.EMSApi.TEMSClientAPI.UpdateModuleResource
• REST.Backend.EMSApi.TEMSClientAPI.UpdateInstallation

• REST.Backend.EMSApi.TEMSClientAPI.PutResource