Overview
Torii integrates with ADP Lyric and syncs:
- Employees and licenses from your ADP Lyric account.
- You can constantly stay updated with application information from our Integrations Page >> Integration Capabilities button >> Integration Capabilities table.
Requirements
To connect this integration, we require the following:
Accounts & Permissions
- An ADP Lyric account (the product formerly named ADP NextGen HCM).
- API access provisioned through ADP API Central for ADP Vantage HCM, ADP Enterprise HR and ADP Lyric, available on the ADP Marketplace.
- A practitioner-level user, so the API returns your full worker list.
- This integration is for ADP Lyric only. If you use ADP Workforce Now, connect Torii's separate ADP integration instead - its credentials come from a different API Central listing and are not interchangeable.
Required keys
- Client ID
- Client Secret
- Certificate
- Private Key
How to Generate the Required Values
Follow these steps to generate the required values:
Step 1: Add ADP API Central to your ADP account
- In the ADP Marketplace, open ADP API Central for ADP Vantage HCM, ADP Enterprise HR and ADP Lyric.
- Add it to your account and complete the setup with your ADP representative.
Step 2: Enable access to worker data
- In ADP API Central, select the worker APIs your organization wants to share.
- Make sure the following application scope is included, otherwise the connection will fail with a scope error:
/hr/workerInformationManagement/workerManagement/workerProfileManagement/worker.read
Step 3: Generate your certificate and private key
- In ADP API Central, generate a mutual SSL certificate.
- Download both the certificate file and the private key file.
Step 4: Copy your Client ID and Client Secret
- In ADP API Central, open your API credentials.
- Copy the Client ID and the Client Secret.
Important
Your private key is shown only when it is generated. Store it somewhere safe before leaving the page - ADP cannot show it again, and you will need to generate a new certificate if you lose it.
How to Connect the Integration
- Go to the Integrations page in Torii.
- Search for ADP Lyric and click Connect.
- Enter the Account Name, Client ID, Client Secret, Certificate and Private Key. For the certificate and the private key, paste the full contents of each file.
- Click Connect.
Update the User Lifecycle settings
To make sure you get user lifecycle information in Torii, define ADP Lyric as your HR management system.
- Go to Settings >> Users & Employees and, under User lifecycle, click Manage sources.
- Under Human Resource Management Systems, select ADP Lyric. If ADP Lyric is your only source for user management, make sure the other sources are unselected.
- Click Preview changes, then Apply changes.
Q&A
Q: What should I enter in the "Account Name" field?
A: The Account Name field lets you connect multiple ADP Lyric accounts to Torii. The value can be anything you choose - it is only used to distinguish between your connected accounts. Make sure to use a unique Account Name for each account: connecting a different account with an Account Name that is already in use will overwrite the existing account's data, so choosing distinct names is your responsibility.
Q: I use ADP Workforce Now - is this the right integration?
A: No. Use Torii's ADP integration for ADP Workforce Now. ADP Lyric and ADP Workforce Now are different products, and the API credentials issued for one will not work for the other.
For any further questions, please contact Torii Support.