Skip to main content Skip to complementary content

User: Synchronize user

Information noteLOCKED.

This API is extremely reliable and will not be broken unless absolutely necessary.






Synchronize the user, identified by {userid}, and the user directory, identified by {userdirectory}. This updates the repository database so that it reflects any changes in the user's attributes (or similar) in the external system from which the user originates.

Information noteThis is an asynchronous call and its completion does not necessarily mean that the selected user's attributes were successfully synchronized. For details on the result, always refer to UserManagement_Repository logs located in the %ProgramData%\Qlik\Sense\Log\Repository\Trace folder.



Return value


  • True: The user synchronization was a success.
  • False: The user synchronization failed.

Optional parameters


Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!