Syncing Persons/Users/Speaker with External Directory via API

Purpose

This integration allows Person (Internal Contact), User and Speaker records within Nexus to stay in-sync with an external directory. This requires the client to setup a process where changes made in an external directory trigger an API call to add/update/inactivate related records within Nexus. This function would use the PUT User Data API Method to make these updates in Nexus.

Definitions:

Person Record - This is the underlying 'contact' record for every person in the system. This holds their primary info like name, job title, email, etc

User - This gives a person the ability to actually login and access Nexus. It stores information like Username, Password, access level, etc. A user record cannot exist without being linked to a person record.

Speaker - This allows a person to be assigned to agenda topics and be invited as a speaker/presenter. A speaker record cannot exist without being linked to a person record.

Using the Nexus API to Sync Person/User/Speaker Records:

• The PUT User Data API Method is used to Add/Update/Inactivate records within Nexus, based on changes in the source directory.
  • The method uses a 'keyEmail' address as the unique identifier.
• The GET User Data method can be used to simply query a person using email address and retrieve all information on them.

Additional Info

• For batch updates, client can reference the 'date last updated' in their internal directory, and send updates to Nexus only for people who were updated since last update date/time.
• If client is using SSO, user profiles can be auto-generated through SSO when a valid new user is authenticated. A user profile does not need to exist ahead of time.
• General API Documentation