Report errors or omissions

Integrate ADP

ADP is a cloud-based management solution for human resources, such as payroll, benefits, and tax management  (see https://www.adp.com/). You can configure your ADP account for Single Sign-On (SSO) through Identity as a Service.

Note: This guide was tested using previous versions of Identity as a Service and ADP. Other versions of ADP may require integration and configuration steps that differ from those documented in this procedure. For newer versions of ADP, this integration guide may be used as an initial approach for integrating ADP. In the event of other issues, contact support@entrust.com for assistance.

Prerequisites

Before you begin, add a PersonImmutableID attribute in Active Directory.

To integrate ADP with Identity as a Service, you must do the following:

Step 1: Create and map a custom user attribute for ADPStep 1: Create and map a custom user attribute for ADP

Create custom user attributes in Identity as a Service

You need to create custom user attribute to fully integrate ADP.

Create a custom PersonImmutableID attribute as follows:

Click > Members > Attributes. The User Attributes List page appears.

Under Custom User Attributes, click Add. The Add User Attribute dialog box appears.

Enter PersonImmutableID for the User Attribute Name.

Select Attribute is required to make the user attribute mandatory.

Click Add.

Map the ADP employeeID/ADP WFN Associate ID to the PersonImmutableID attribute, as follows:

Click > Directories. The Directories List page appears.

Click the directory name. The Edit Directory page appears.

Scroll to the Custom User Attributes and locate PersonImmutableID.

Enter PersonImmutableID in the field to map to the PersonImmutableID attribute.

 Click Save.

Click to the right of the directory to synchronize it with your Active Directory.

Ensure that the ADP generated Employee ID/Associate ID is present and it is populated for all users.

Click > Users. The Users List page appears.

Select a user and scroll to the PersonImmutableID user attribute and confirm that the field has been populated.

Note: ADP requires PersonImmutableID to recognize your employee in your organization's authentication server. Your organization should not reuse this value to associate it with other employees. PersonImmutableID is a unique value between 1 and 100 characters in length and includes English letters and numbers.

Step 2: Add ADP to Identity as a ServiceStep 2: Add ADP to Identity as a Service

Add ADP to Identity as a Service

Log into your Identity as a Service administrator account.

Click > Security > Applications. The Applications Lists page appears.

Click Add. The Select an Application Template page appears.

Do one of the following:

Select SAML Cloud Integrations from the search drop-down list and scroll to find the application you want to add to IDaaS.

- or -

In the Search bar, enter a search option to filter for the application you want to add to IDaaS.

Click ADP. The Add ADP page appears.

Enter an Application Name.

Enter an Application Description.

Optional. Add a custom application logo.

Click next to Application Logo. The Upload Logo dialog box appears.

Click  to select an image file to upload.

Browse to select your file and click Open. The Upload Logo dialog box reappears showing your selected image.

If required, resize your image.

Click OK.

Select the Authentication Flow that appears to users during login.

Click Next. The General page appears.

If available, use the Upload Metadata XML file option to auto-populate the following fields, if available in the file:

Default Assertion Consumer Service URL

Alternative Assertion Consumer URLs

Service Provider Entity ID (Issuer)

Single Logout Service URL

SAML Signing Certificate

SAML NameID Encoding Format

SAML Signature Algorithm

To import the Metadata file:

Click and browse to select the file. The Metadata Configuration dialog box appears.

If required, click Merge with existing values to merge new values with existing values for Alternative Assertion Consumer Services URLs and SAML attribute names.

Click Save.

If you do not have a metadata file, enter the following:

Enter the Default Assertion Consumer Service URL for the SAML application.

Enter the Service Provider Entity ID (Issuer) that is used by Identity as a Service to identify the SAML service provider.

If your SAML service provider supports SAML SP-initiated logout, set the Single Logout Service URL to the value supplied by your SAML service provider. Otherwise, leave it blank.

Note: Identity as a Service performs session logout based on the Authentication Session Lifetime (see Manage General settings). The default value for this setting is 15 minutes. Set this parameter to an appropriate value according to your site security policy. 

Identity as a Service also supports SP-initiated logout (SLO) from a SAML client application. In this case, the SAML application can be configured with a Single Logout URL. When a SAML request is sent, using either the HTTP-Redirect or HTTP-POST SAML binding, Identity as a Service logs out the current user session and the user is redirected to the configured Single Logout URL of the SAML client application using HTTP-POST binding. The binding used in the response is not configurable. 

- SAML SP-initiated logout is not propagated to all other SAML SPs.
- Identity as a Service does not support IDP-initiated SAML logout.

Optional. Enter the SAML Username Parameter Name used to identify the user ID being requested for authentication.

The user ID can then be passed as a parameter, for example, Username=jdoe. Alternately, if the SAML username is NameID, the SAML Request XML NameID element value is used to the identity the IDaaS userID

Optional. Enter the SAML Username Parameter Name used to identity the user ID being requested for authentication. The user ID can then be passed as a parameter, for example, Username=jdoe.

Enter the SAML Session Timeout to the time when the SAML Assertion times out. The maximum is 720 minutes.

Enter the Max Authentication Age (seconds) to set the maximum amount of time that can elapse before a user is required to reauthenticate during a new login attempt. This applies for both SP-initiated and IDP-initiated login. Set this field to -1 to disable this feature.

From the SAML Name ID Attribute drop-down list, select User ID.

From the SAML NameID Encoding Format, select UNSPECIFIED.

From the SAML Response Signature Algorithm, selectSHA256.

Select the SAML Signing Certificate from the drop-down list.

Select Sign complete SAML response to ensure the message integrity of the SAML response sent to the application during authentication.

Optional: Select Respond Immediately for Unsuccessful Responses to return to the application immediately after a login failure, rather than allow user to try again with a different userID.

Deselect Enable Go Back Button if you do not want users to be able to go back to the ADP login page to log in.

Select Show Default Assertion Consumer URL Service in the My Profile. When selected, the Default Assertion Consumer URL appears in a user's My Profile page in addition to relay states and Alternative Assertion Consumer URLs.

Optional. Add Alternative Assertion Consumer Service URLs, as follows:

Click Add.

Enter a Name.

Enter a URL Value.

Select Show in My Profile to display the Alternative Consumer Service URL in a user's My profile page.

Optional. Add an Application Logo.

Click Add.

Repeat these steps to add more Alternative Assertion Consumer Service URLs.

Under SAML Attribute(s), do the following:

Click Add.

In the Name field, enter PersonImmutableID.

Click Add in the Value(s) field, type < and select the PersonImmutableID attribute.

Click Edit.

Click Submit.

Step 3: Add a resource ruleStep 3: Add a resource rule

See Create resource rules.

Step 4: Download the Metadata file from Identity as a ServiceStep 4: Download the Metadata file from Identity as a Service

Download the Metadata file from Identity as a Service

In Identity as a Service, click > Security > Applications. The Applications List page appears.

Do one of the following:

Click next to the application you are integrating with Identity as a Service.

–or–

Click next to the application you are integrating with Identity as a Service and select SAML IDP Metadata.

 The SAML Application Metadata dialog box appears.

Select the certificate to include in the SAML IDP Metadata file from the drop-down list.

If applicable, Select the domain to include in the SAML IDP Metadata file from the drop-down list.

Enter the Lifetime, in days, for the SAML IDP Metadata file. The value must be between 2 and 730.

Do one of the following, as required:

Copy the Public Endpoint to paste into your SAML application being used Identity Provider authentication.

Click Download.

Note:  If you are using multiple domains, you must download each domain's metadata file separately because the values in the metadata file vary for each domain.

Step 5: Configure ADP for Identity as a Service single sign-onStep 5: Configure ADP for Identity as a Service single sign-on

Configure ADP for Identity as a Service single sign-on

Log in to your ADP account as an administrator.

From the Federation Setup menu, select Identity Provider.

From the Web Setup menu, select Services Selection, check applicable service(s) for connection, click Next

From Configure, read through the step by step up instructions, and then click Next.

Under Upload Metadata, browse to select the metadata file you downloaded in Step 4: Download the metadata from Identity as a Service.

Click Upload.The Federated Issuer Key auto-populates.

Click Next.

Under Provision User(s), upload the unique identifier using a .csv file or Use employee ID/WFN Associate ID as the Person Immutable ID.

Step 6: Test the integrationStep 6: Test the integration

Testing Service Provider Login

Open a Web browser and enter the URL for your ADP account. You are directed to Identity as a Service.

Enter your ADP account User ID and click Next.

Respond to the second-factor authentication challenge. If you respond successfully, you are logged in to the ADP Home page.

Testing Identity as a Service redirect log in

Log in to your Identity as a Service account.

Go to your My Profile page if you are not already there.

Under Applications, click ADP.

Respond to the second-factor authentication challenge. If you respond successfully, you are logged in to ADP.