Skip to content

Commit 9e8bd4e

Browse files
authored
Merge pull request #92961 from v-nagta/paylocity
Product Backlog Item 837753: SaaS App Tutorial: Paylocity
2 parents 87b511a + 8a02845 commit 9e8bd4e

File tree

2 files changed

+165
-0
lines changed

2 files changed

+165
-0
lines changed
Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with Paylocity | Microsoft Docs'
3+
description: Learn how to configure single sign-on between Azure Active Directory and Paylocity.
4+
services: active-directory
5+
documentationCenter: na
6+
author: jeevansd
7+
manager: mtillman
8+
ms.reviewer: barbkess
9+
10+
ms.assetid: f5e5a71f-ea04-4533-ba58-0ec85fdf0982
11+
ms.service: active-directory
12+
ms.subservice: saas-app-tutorial
13+
ms.workload: identity
14+
ms.tgt_pltfrm: na
15+
ms.devlang: na
16+
ms.topic: tutorial
17+
ms.date: 10/23/2019
18+
ms.author: jeedes
19+
20+
ms.collection: M365-identity-device-management
21+
---
22+
23+
# Tutorial: Azure Active Directory single sign-on (SSO) integration with Paylocity
24+
25+
In this tutorial, you'll learn how to integrate Paylocity with Azure Active Directory (Azure AD). When you integrate Paylocity with Azure AD, you can:
26+
27+
* Control in Azure AD who has access to Paylocity.
28+
* Enable your users to be automatically signed-in to Paylocity with their Azure AD accounts.
29+
* Manage your accounts in one central location - the Azure portal.
30+
31+
To learn more about SaaS app integration with Azure AD, see [What is application access and single sign-on with Azure Active Directory](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis).
32+
33+
## Prerequisites
34+
35+
To get started, you need the following items:
36+
37+
* An Azure AD subscription. If you don't have a subscription, you can get a [free account](https://azure.microsoft.com/free/).
38+
* Paylocity single sign-on (SSO) enabled subscription.
39+
40+
## Scenario description
41+
42+
In this tutorial, you configure and test Azure AD SSO in a test environment.
43+
44+
* Paylocity supports **SP and IDP** initiated SSO
45+
46+
## Adding Paylocity from the gallery
47+
48+
To configure the integration of Paylocity into Azure AD, you need to add Paylocity from the gallery to your list of managed SaaS apps.
49+
50+
1. Sign in to the [Azure portal](https://portal.azure.com) using either a work or school account, or a personal Microsoft account.
51+
1. On the left navigation pane, select the **Azure Active Directory** service.
52+
1. Navigate to **Enterprise Applications** and then select **All Applications**.
53+
1. To add new application, select **New application**.
54+
1. In the **Add from the gallery** section, type **Paylocity** in the search box.
55+
1. Select **Paylocity** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
56+
57+
## Configure and test Azure AD single sign-on for Paylocity
58+
59+
Configure and test Azure AD SSO with Paylocity using a test user called **B.Simon**. For SSO to work, you need to establish a link relationship between an Azure AD user and the related user in Paylocity.
60+
61+
To configure and test Azure AD SSO with Paylocity, complete the following building blocks:
62+
63+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
64+
* **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
65+
* **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
66+
1. **[Configure Paylocity SSO](#configure-paylocity-sso)** - to configure the single sign-on settings on application side.
67+
* **[Create Paylocity test user](#create-paylocity-test-user)** - to have a counterpart of B.Simon in Paylocity that is linked to the Azure AD representation of user.
68+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
69+
70+
## Configure Azure AD SSO
71+
72+
Follow these steps to enable Azure AD SSO in the Azure portal.
73+
74+
1. In the [Azure portal](https://portal.azure.com/), on the **Paylocity** application integration page, find the **Manage** section and select **single sign-on**.
75+
1. On the **Select a single sign-on method** page, select **SAML**.
76+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
77+
78+
![Edit Basic SAML Configuration](common/edit-urls.png)
79+
80+
1. On the **Basic SAML Configuration** section, the user does not have to perform any step as the app is already pre-integrated with Azure.
81+
82+
![Paylocity Domain and URLs single sign-on information](common/preintegrated.png)
83+
84+
1. Click **Set additional URLs** and perform the following step if you wish to configure the application in **SP** initiated mode:
85+
86+
In the **Sign-on URL** text box, type a URL:
87+
`https://access.paylocity.com/`
88+
89+
1. Click **Save**.
90+
91+
1. Paylocity application expects the SAML assertions in a specific format, which requires you to add custom attribute mappings to your SAML token attributes configuration. The following screenshot shows the list of default attributes.
92+
93+
![image](common/default-attributes.png)
94+
95+
1. In addition to above, Paylocity application expects few more attributes to be passed back in SAML response which are shown below. These attributes are also pre populated, but you have to update these attributes with the real values.
96+
97+
| Name | Source Attribute|
98+
| ---------------| --------------- |
99+
| PartnerID | <"PartnerID"> |
100+
| PaylocityUser | <"PaylocityUser"> |
101+
| PaylocityEntity | <"PaylocityEntity"> |
102+
103+
1. On the **Set up single sign-on with SAML** page, in the **SAML Signing Certificate** section, find **Federation Metadata XML** and select **Download** to download the certificate and save it on your computer.
104+
105+
![The Certificate download link](common/metadataxml.png)
106+
107+
1. On the **Set up Paylocity** section, copy the appropriate URL(s) based on your requirement.
108+
109+
![Copy configuration URLs](common/copy-configuration-urls.png)
110+
111+
### Create an Azure AD test user
112+
113+
In this section, you'll create a test user in the Azure portal called B.Simon.
114+
115+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
116+
1. Select **New user** at the top of the screen.
117+
1. In the **User** properties, follow these steps:
118+
1. In the **Name** field, enter `B.Simon`.
119+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
120+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
121+
1. Click **Create**.
122+
123+
### Assign the Azure AD test user
124+
125+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to Paylocity.
126+
127+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
128+
1. In the applications list, select **Paylocity**.
129+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
130+
131+
![The "Users and groups" link](common/users-groups-blade.png)
132+
133+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
134+
135+
![The Add User link](common/add-assign-user.png)
136+
137+
1. In the **Users and groups** dialog, select **B.Simon** from the Users list, then click the **Select** button at the bottom of the screen.
138+
1. If you're expecting any role value in the SAML assertion, in the **Select Role** dialog, select the appropriate role for the user from the list and then click the **Select** button at the bottom of the screen.
139+
1. In the **Add Assignment** dialog, click the **Assign** button.
140+
141+
## Configure Paylocity SSO
142+
143+
To configure single sign-on on **Paylocity** side, you need to send the downloaded **Federation Metadata XML** and appropriate copied URLs from Azure portal to [Paylocity support team](mailto:[email protected]). They set this setting to have the SAML SSO connection set properly on both sides.
144+
145+
### Create Paylocity test user
146+
147+
In this section, you create a user called B.Simon in Paylocity. Work with [Paylocity support team](mailto:[email protected]) to add the users in the Paylocity platform. Users must be created and activated before you use single sign-on.
148+
149+
## Test SSO
150+
151+
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
152+
153+
When you click the Paylocity tile in the Access Panel, you should be automatically signed in to the Paylocity for which you set up SSO. For more information about the Access Panel, see [Introduction to the Access Panel](https://docs.microsoft.com/azure/active-directory/active-directory-saas-access-panel-introduction).
154+
155+
## Additional resources
156+
157+
- [ List of Tutorials on How to Integrate SaaS Apps with Azure Active Directory ](https://docs.microsoft.com/azure/active-directory/active-directory-saas-tutorial-list)
158+
159+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
160+
161+
- [What is conditional access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
162+
163+
- [Try Paylocity with Azure AD](https://aad.portal.azure.com/)

articles/active-directory/saas-apps/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -978,6 +978,8 @@
978978
href: patentsquare-tutorial.md
979979
- name: Pavaso Digital Close
980980
href: pavaso-digital-close-tutorial.md
981+
- name: Paylocity
982+
href: paylocity-tutorial.md
981983
- name: Peakon
982984
href: peakon-tutorial.md
983985
- name: Pega Systems

0 commit comments

Comments
 (0)