Integrate with ADP

Use JumpCloud SAML Single Sign On (SSO) to give your users convenient but secure access to all their web applications with a single set of credentials. Automatically provision, update and deprovision users and groups in ADP from JumpCloud using the Identity Management (SCIM) integration. Leverage this integration to centralize user lifecycle, user identity, and group management in JumpCloud for ADP. Save time and avoid mistakes, as well as potential security risks, related to manually creating users.

Read this article to learn how to integrate with ADP. 

Prerequisites

• A JumpCloud administrator account
• JumpCloud SSO Package or higher or SSO à la carte option
• An ADP user account with administrator permissions
• An API add on is required to access ADP's API
• A Client ID and Secret from ADP (part of the API add on package)
• If using mTLS, a private key and certificate

Important Considerations

• A custom API connector configuration to import users is also available for ADP - use the prebuilt if you would like to manage SSO and SCIM in one app

Attribute Considerations

• A default set of attributes are managed for users. See the Attribute Mappings section for more details
• It is highly recommended to map all of the listed optional JumpCloud attributes. The dropdown shows all the optional user attributes that can be mapped to create a complete user profile

Creating a new JumpCloud Application Integration

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Click + Add New Application.
4. Type the name of the application in the Search field and select it.
5. Click Next.
6. In the Display Label, type your name for the application. Optionally, you can enter a Description, adjust the User Portal Image and choose to hide or Show in User Portal.

7. Optionally, expand Advanced Settings to specify a value for the SSO IdP URL. If no value is entered, it will default to https://sso.jumpcloud.com/saml2/<applicationname>.

8. Click Save Application.
9. If successful, click:
   • Configure Application and go to the next section
   • Close to configure your new application at a later time

Configuring the SSO Integration

To configure JumpCloud 1

1. Create a new application or select it from the Configured Applications list.
2. Select the SSO tab.
3. Copy and paste your ADP ACS_URL.
4. Add or change any attributes.
5. Click save.

Download the certificate

1. Find your application in the Configured Applications list and click anywhere in the row to reopen its configuration window.
2. Select the SSO tab and click IDP Certificate Valid > Download certificate.

To configure ADP

1. Contact your ADP representative to request that they complete the ADP side of the SAML configuration, providing them with the Issuer URL (JumpCloud IdP Entity ID) and X.509 certificate downloaded in the previous step.
2. When your ADP representative has confirmed that they have completed the ADP SAML setup, request the ADP Relay State for your app.

To configure JumpCloud 2

1. Open ADP from the Configured Applications list.
2. Select the SSO tab.
3. Paste the ADP Relay State received from your ADP representative in the Default Relay State field.
4. Click Save.

Authorizing User SSO Access

Users are implicitly denied access to applications. After you connect an application to JumpCloud, you need to authorize user access to that application. You can authorize user access from the Application Configuration panel or from the Groups Configuration panel. 

To authorize user access from the Application Configuration panel

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications, then select the application to which you want to authorize user access.
3. Select the User Groups tab. If you need to create a new group of users, see Get Started: User Groups.
4. Select the check box next to the group of users you want to give access.
5. Click save. 

To learn how to authorize user access from the Groups Configuration panel, see Authorize Users to an SSO Application.

Validating SSO user authentication workflow(s)

IdP-initiated user workflow

• Access the JumpCloud User Console
• Go to Applications and click an application tile to launch it
• JumpCloud asserts the user's identity to the SP and is authenticated without the user having to log in to the application

SP-initiated user workflow

• Go to the SP application login - generally, there is either a special link or an adaptive username field that detects the user is authenticated through SSO

• Login redirects the user to JumpCloud where the user enters their JumpCloud credentials
• After the user is logged in successfully, they are redirected back to the SP and automatically logged in

Configuring the Identity Management Integration

To configure ADP

1. If you do not have your ADP Client ID and Secret, request it from ADP.
2. A private key and matching Web Services (WS) Certificate is required to access ADP web services.

3. Create a CSR and upload it to ADP's cert request platform to generate a security certificate.

4. Download the cert - choose the Certificate only, PEM encoded download option
5. Use the Certificate, Private Key (from the CSR), Client ID and Client Secret to submit a bearer token request - Postman was used in this instance.
6. Use the bearer token to authenticate to the API.

To configure JumpCloud

1. Create a new application or select it from the Configured Applications list.
2. Select the Identity Management tab.
3. Under Configuration settings > Service Provider Configuration > API Type, choose Custom API Import.
4. Optionally, if you want to use a method for mutual authentication, check Use mTLS authentication under Mutual TLS (mTLS). Add the following required files:
   • Private Key - click Choose File and then browse to and select the private key file
   • Certificate - click Choose File and then browse to and select the certificate file
5. Click OAuth 2.0 and then select Client Credentials.
6. Enter values in the following required fields:
   • Client ID - copy and paste the Client ID
   • Client Secret - copy and paste the Client Secret
   • Access Token URL - enter https://accounts.adp.com/auth/oauth/v2/token
7. Leave the Scopes field blank.

8. Under Endpoint Configuration in the Base URL field, enter https://api.adp.com/hr/v2

List Users

Location

1. Resource Location - workers
2. Method - This field is greyed out (not changeable) and is always set to GET.
3. Endpoint Path - /workers?count=true

Total count

1. Response Parameter Location - select Body
2. Response Body JSON Path - meta.totalNumber

Pagination

1. For API Key and Bearer Token Configurations, select Test Connection.
   • If successful - you will receive a success message and the fields for attribute mapping will appear.
   • unsuccessful - you will receive a failure notification that slides out from the right of the panel and the full error responses received from the service provider will be shown at the bottom of the Configuration Settings section.
2. Limit Name - $top
3. Offset Name - $skip

User Schema Attribute Mappings

1. Unique ID - associateOID
2. User Status - workerStatus.statusCode.codeValue
3. Inactive Status Values - Terminated,Retired,Deceased

Attribute Mappings

The following table lists attributes that JumpCloud sends to the application. See Attribute Considerations for more information regarding attribute mapping considerations. 

Learn about JumpCloud Properties and how they work with system users in our API. 

1. After completing the mappings using the below table, click Preview Mappings to verify the mappings.
2. If the mappings are correct, click Activate.

Importing New Users and Updates

1. Create a new application or select it from the Configured Applications list.
2. Select the Identity Management tab.
   
3. There are several settings available for importing users from your custom application to JumpCloud. Warning: Selected import options will apply to both manual and scheduled imports. 
   • Expand the Import Users section.
     • Manual Import - clicking the Start Manual Import button kicks off the process flow for doing an immediate and one-time import of users from your custom application to JumpCloud. 
     • Scheduled Imports (hourly) - enabled by default for all new connectors. The first scheduled import will start within an hour after the new connector is saved. Scheduled imports will then run at the same time every hour as the initial scheduled import. Important: Any connectors created prior to the availability of scheduled imports will have this option disabled. To run scheduled imports, you must enable this option.
     • Selecting the Receive summary email after each scheduled import results in user import complete emails being sent after each hourly import. Tip: It's recommended to enable this for the first few scheduled imports to ensure the imports are running correctly. 
   • In the Import Settings section, you can optionally choose:
     • Allow reactivation of users on update. Checking the box for this setting will result in the user state changing from Suspended to Active in JumpCloud when a user’s status changes from either Leave or Inactive to Onboarding or Active in your custom application.  
     • Apply Advanced Filters on import (optional). See your custom application's API documentation for available filters.

To start a manual user import

1. Expand the Import Users section and click Start Manual Import.
2. Select one of the following options: 
   • Import new users and user updates
   • Only import new users
   • Only import user updates
   • View and select specific new users to import (updates not supported)

3. Click Continue.
4. If you selected the View and select specific new users to import (updates not supported).
   • Select the users you want to import.

5. The count of users to be imported will show at the bottom left hand of the list. If this is correct, click Import. 
6. Review the information in the results modal.
7. Click one of the tiles to navigate to the Users page, User Groups page, or Device Groups page or close the modal.​

8. You will receive a User Import Complete email with a summary of the import results and a link for downloading a copy of the import results.
9. You can now connect users to all their JumpCloud resources. Learn more in the Authorize Users to an SSO App and Connect New Users to Resources articles.

SCIM Directory Insights Events

The following Directory Insights (DI) events provide visibility into failures and detailed information about the user and group data being added or updated from HR or other external solutions to JumpCloud.

Removing the Integration

To deactivate the IdM Integration

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application that you’d like to deactivate and click to open its details panel. 
4. Under the company name and logo on the left hand panel, click the Deactivate IdM connection link.
5. Click confirm. 
6. If successful, you will receive a confirmation message.

To deactivate the SSO Integration or Bookmark

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application that you’d like to deactivate and click to open its details panel. 
4. Select the SSO or Bookmark tab.
5. Scroll to the bottom of the configuration.
6. Click Deactivate SSO or Deactivate Bookmark. 
7. Click save. 
8. If successful, you will receive a confirmation message.

To delete the application

1. Log in to the JumpCloud Admin Portal.
2. Go to USER AUTHENTICATION > SSO Applications.
3. Search for the application that you’d like to delete.
4. Check the box next to the application to select it.
5. Click Delete.
6. Enter the number of the applications you are deleting
7. Click Delete Application.
8. If successful, you will see an application deletion confirmation notification.