Learn what the User Sync Tool does, when to use it, and where to find the setup, configuration, and command reference.
The User Sync Tool is a command-line tool that moves user and group information from your organization's enterprise directory system, such as Active Directory or another LDAP system, to your organization's directory in the Adobe Admin Console. You install it on a server you manage and run it on a schedule to keep Adobe user and group membership in sync with your directory.
When to use the User Sync Tool
The User Sync Tool automates user management for Federated ID and Enterprise ID users by syncing from your enterprise directory. It is one of several directory-based options. If your organization uses Microsoft Azure or Google federation, you can use a connector instead:
To manage users without a directory sync, you can also add users individually or in bulk.
Before you begin
In the Adobe Admin Console
- Create your directories.
- Create the product profiles and user groups that you plan to map to.
Server
Install the tool on a server that:
- Has internet access and can reach your directory service, such as LDAP or AD.
- Is protected and secure, because it stores or accesses your administrative credentials.
- Stays available and reliable, with backup and recovery.
- Can send email, so the tool can send reports to administrators.
- Uses a 64-bit processor when running Windows.
API credentials
Create credentials for the User Management API in the Adobe Developer Console. The tool authenticates with OAuth Server-to-Server, which requires a client ID and a client secret.
JWT (Service Account) authentication is deprecated and will be removed in a future version of the tool. Use OAuth Server-to-Server.
Set up, configure, and run the tool
The User Sync Tool project maintains the full instructions for installing, configuring, and running the tool. Use these resources:
For the API that the tool uses, see the User Management API documentation.
