WorkOS Docs Homepage
Integrations

ADP OpenID Connect

Learn how to configure a connection to ADP via OIDC.

Each SSO Identity Provider requires specific information to create and configure a new Connection. Often, the information required to create a connection will differ by Identity Provider.

ADP is unique in that it authenticates using the Open ID Connect (OIDC) protocol instead of SAML. This means that instead of providing an ACS URL and SP Entity ID into the IdP, The IdP will provide a client ID and secret. ADP also provides an SSL Certificate and Private RSA Key file to authenticate. These four pieces of information will all need to be uploaded into the WorkOS dashboard in the steps below.

Navigate to the Organization in your WorkOS Dashboard under which you would like to set up this new SSO connection. Click on the “Manually Configure Connection” button.

A screenshot showing where to find "Manually Configure Connection" in the WorkOS Dashboard.

Select ADP OIDC as the Identity Provider and select “Create Connection”.

A screenshot showing "Create Connection" details in the WorkOS Dashboard.

Login to the ADP Partner Self Service Portal.

From this page there are two environments to select from, Development and Production. Please use the environment that best suits your use-case for this SSO connection.

In the selected environment select “Create New Project”.

A screenshot showing the Projects Overview page in the ADP Partner Self Service Portal.

Give the project a meaningful name to designate the SSO connection, there is no need to add a description.

A screenshot showing the Create New Project details in the ADP Partner Self Service Portal.

Make the selections “US Marketplace” and “ADP Workforce Now” respectively for the next selections and then click “Next”.

A screenshot showing selection options for the ADP Marketplace in the ADP Partner Self Service Portal.

Finally, select “Other” for the use case that best describes your application and click “Submit”.

A screenshot showing app description selection options in the ADP Partner Self Service Portal.

After configuring the ADP project, the next step is to provide ADP with the redirect URI generated by WorkOS.

A screenshot showing where to find the ACS URL and SP Entity ID in the WorkOS Dashboard.

Now that a new project has been created browse to the “Development API Credentials” Tab within the project.

Click on the “End-User/SSO sub-tab” from this view.

Paste the Redirect URI into the App redirect URI field and click “Update Redirect”.

A screenshot showing where to place the WorkOS Single Sign-On URL and SP Entity ID in the ADP Partner Self Service Portal.

Now that the redirect URI has been provided, the next step is to gather the Client ID and Client Secret from ADP and add it into the WorkOS Dashboard.

Under the same tab used in the previous step, you’ll provide the Client ID and Client Secret from ADP. Click to reveal the secret and copy and paste both the client ID and client secret into the WorkOS dashboard.

A screenshot showing where to find the ADP Client Credentials in the ADP Partner Self Service Portal.
A screenshot showing where to enter the ADP Client Credentials WorkOS Dashboard.

Now that the Client ID and Secret have been provided, the next step is to gather the SSL Certificate and Private Key from ADP and add it into the WorkOS Dashboard.

ADP uses a two fold certificate method with an SSL certificate and an SSL Private Key. The SSL Private Key is only displayed one time when the certificate is generated. If the certificate has already been generated, the IT Administrator who generated it should have also received the Private Key otherwise a new certificate and key can be generated by browsing to the certificates tab on the left hand navigation.

The SSL Certificate can be found in ADP by browsing to “Certificate” on the left hand nav bar. You can also create a new SSL Certificate and Private Key pair if necessary.

A screenshot showing where to download the ADP SSL Certificate and Private Key in the ADP Partner Self Service Portal.

Upload the two files into your WorkOS dashboard in their respective portals on the connection page and click “Update Connection”.

A screenshot showing where to upload the ADP SSL Certificate and Private Key in the WorkOS Dashboard

Navigate back to the connection in your WorkOS dashboard. After a minute or two you should see the connection become Active as indicated by the green badge next to the connection name.

All that’s left to do now is test out the connection. You can use your own application if it’s connected to WorkOS already, or feel free to use one of our example applications like this Python Flask SSO app to get up and running with a PoC quickly