Workday Directory Sync
Learn about syncing your user list with Workday
This guide outlines how to synchronize your application's Workday directories.
To synchronize an Enterprise's users and groups provisioned for your application, you'll need the following information from the Enterprise:
- The Workday Custom Report JSON endpoint
- The Workday Custom Group Report JSON endpoint
- Username for accessing the Custom Report endpoint
- Password for accessing the Custom Report endpoint
1Create an Integration System User
It's recommended that the Enterprise creates an Integration System User within Workday. The Integration System User will be used to access Custom Reports.
If at the end of all this, everything works as expected but fields are missing from the Report, ensure that the user created has access to access to the fields.
2Create Custom Reports
The Enterprise will need to create two Custom Reports for WorkOS to use. The first Custom Report will be used for syncing User information. The second report will be used for syncing Group information.
When creating the report, make sure to select the Advanced report type and to have the Enable as Web Service checkbox checked off.
3Populate Custom Reports
WorkOS looks for the following information in the User Report, all of which can be properly mapped later on so no need to worry about naming or having a column for each field:
- Unique ID
- First Name
- Last Name
- Group Name
Along the same lines as the User Report, WorkOS looks for the following information in the Group Report:
- Group Name
4Add an authorized user
If an Integration System User was created, the Enterprise will want to have that user added as an authorized user. This can be found under the Share tab from within a Report.
5Get the RaaS endpoint
Now that the Report itself is setup and access to it had been configured, the Enterprise will need to get the RaaS endpoint. The page with the endpoints can be found under Actions-> Web Service -> View URLs.
Once on the URLs page, the one that WorkOS will need is listed under the JSON section.
6Create your Directory Sync Connection
Login to your WorkOS Dashboard and select "Organizations" from the left hand navigation bar.
Select the organization you'll be configuring a new Directory Sync Connection with.
Click "Add Directory".
Input the Company Name, Domain, and select "Workday" as the directory type.
Click the "Create Connection" button.
7Setup your Directory Sync Connection
Input your Enterprise's Custom Report JSON endpoints, username and password.
Then, click "Update Directory".
8Map Custom Report fields
Map the required fields back to the Custom Report.
9Assign users and groups to your application
Now, whenever your Enterprise customer assigns users or groups to your application, you'll receive Dashboard updates based on changes in their directory.