Skip to content

Commit 58cc4ec

Browse files
authored
Merge pull request #88931 from v-viinde/cakehr
Product Backlog Item 816700: SaaS App Tutorial: CakeHR
2 parents a033b73 + 68eae4c commit 58cc4ec

File tree

6 files changed

+196
-0
lines changed

6 files changed

+196
-0
lines changed
Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
---
2+
title: 'Tutorial: Azure Active Directory single sign-on (SSO) integration with CakeHR | Microsoft Docs'
3+
description: Learn how to configure single sign-on between Azure Active Directory and CakeHR.
4+
services: active-directory
5+
documentationCenter: na
6+
author: jeevansd
7+
manager: mtillman
8+
ms.reviewer: barbkess
9+
10+
ms.assetid: 1c9bbdb1-ac47-4fb8-a1cc-1e647b0323a7
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: 09/19/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 CakeHR
24+
25+
In this tutorial, you'll learn how to integrate CakeHR with Azure Active Directory (Azure AD). When you integrate CakeHR with Azure AD, you can:
26+
27+
* Control in Azure AD who has access to CakeHR.
28+
* Enable your users to be automatically signed-in to CakeHR 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+
* CakeHR 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+
* CakeHR supports **SP** initiated SSO
45+
46+
> [!NOTE]
47+
> Identifier of this application is a fixed string value so only one instance can be configured in one tenant.
48+
49+
## Adding CakeHR from the gallery
50+
51+
To configure the integration of CakeHR into Azure AD, you need to add CakeHR from the gallery to your list of managed SaaS apps.
52+
53+
1. Sign in to the [Azure portal](https://portal.azure.com) using either a work or school account, or a personal Microsoft account.
54+
1. On the left navigation pane, select the **Azure Active Directory** service.
55+
1. Navigate to **Enterprise Applications** and then select **All Applications**.
56+
1. To add new application, select **New application**.
57+
1. In the **Add from the gallery** section, type **CakeHR** in the search box.
58+
1. Select **CakeHR** from results panel and then add the app. Wait a few seconds while the app is added to your tenant.
59+
60+
## Configure and test Azure AD single sign-on for CakeHR
61+
62+
Configure and test Azure AD SSO with CakeHR 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 CakeHR.
63+
64+
To configure and test Azure AD SSO with CakeHR, complete the following building blocks:
65+
66+
1. **[Configure Azure AD SSO](#configure-azure-ad-sso)** - to enable your users to use this feature.
67+
1. **[Create an Azure AD test user](#create-an-azure-ad-test-user)** - to test Azure AD single sign-on with B.Simon.
68+
1. **[Assign the Azure AD test user](#assign-the-azure-ad-test-user)** - to enable B.Simon to use Azure AD single sign-on.
69+
1. **[Configure CakeHR SSO](#configure-cakehr-sso)** - to configure the single sign-on settings on application side.
70+
1. **[Create CakeHR test user](#create-cakehr-test-user)** - to have a counterpart of B.Simon in CakeHR that is linked to the Azure AD representation of user.
71+
1. **[Test SSO](#test-sso)** - to verify whether the configuration works.
72+
73+
## Configure Azure AD SSO
74+
75+
Follow these steps to enable Azure AD SSO in the Azure portal.
76+
77+
1. In the [Azure portal](https://portal.azure.com/), on the **CakeHR** application integration page, find the **Manage** section and select **single sign-on**.
78+
1. On the **Select a single sign-on method** page, select **SAML**.
79+
1. On the **Set up single sign-on with SAML** page, click the edit/pen icon for **Basic SAML Configuration** to edit the settings.
80+
81+
![Edit Basic SAML Configuration](common/edit-urls.png)
82+
83+
1. On the **Basic SAML Configuration** section, enter the values for the following fields:
84+
85+
a. In the **Sign-on URL** text box, type a URL using the following pattern:
86+
`https://<yourcakedomain>.cake.hr/`
87+
88+
b. In the **Reply URL** text box, type a URL using the following pattern:
89+
`https://<yourcakedomain>.cake.hr/services/saml/consume`
90+
> [!NOTE]
91+
> These values are not real. Update these values with the actual Sign-On URL and Reply URL. Contact [CakeHR Client support team](mailto:[email protected]) to get these values. You can also refer to the patterns shown in the **Basic SAML Configuration** section in the Azure portal.
92+
93+
1. In the **SAML Signing Certificate** section, click **Edit** button to open **SAML Signing Certificate** dialog.
94+
95+
![Edit SAML Signing Certificate](common/edit-certificate.png)
96+
97+
1. In the **SAML Signing Certificate** section, copy the **THUMBPRINT** value and save it on your Notepad.
98+
99+
![Copy Thumbprint value](common/copy-thumbprint.png)
100+
101+
1. On the **Set up CakeHR** section, copy the appropriate URL(s) based on your requirement.
102+
103+
![Copy configuration URLs](common/copy-configuration-urls.png)
104+
105+
### Create an Azure AD test user
106+
107+
In this section, you'll create a test user in the Azure portal called B.Simon.
108+
109+
1. From the left pane in the Azure portal, select **Azure Active Directory**, select **Users**, and then select **All users**.
110+
1. Select **New user** at the top of the screen.
111+
1. In the **User** properties, follow these steps:
112+
1. In the **Name** field, enter `B.Simon`.
113+
1. In the **User name** field, enter the [email protected]. For example, `[email protected]`.
114+
1. Select the **Show password** check box, and then write down the value that's displayed in the **Password** box.
115+
1. Click **Create**.
116+
117+
### Assign the Azure AD test user
118+
119+
In this section, you'll enable B.Simon to use Azure single sign-on by granting access to CakeHR.
120+
121+
1. In the Azure portal, select **Enterprise Applications**, and then select **All applications**.
122+
1. In the applications list, select **CakeHR**.
123+
1. In the app's overview page, find the **Manage** section and select **Users and groups**.
124+
125+
![The "Users and groups" link](common/users-groups-blade.png)
126+
127+
1. Select **Add user**, then select **Users and groups** in the **Add Assignment** dialog.
128+
129+
![The Add User link](common/add-assign-user.png)
130+
131+
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.
132+
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.
133+
1. In the **Add Assignment** dialog, click the **Assign** button.
134+
135+
## Configure CakeHR SSO
136+
137+
1. Open a new web browser window and sign into your CakeHR company site as an administrator.
138+
139+
2. On the top-right corner of the page, click on **Profile** and then navigate to **Settings**.
140+
141+
![CakeHR configuration](./media/cakehr-tutorial/config01.png)
142+
143+
3. From the left side of the menu bar, click on **INTEGRATIONS** > **SAML SSO** and perform the following steps:
144+
145+
![CakeHR configuration](./media/cakehr-tutorial/config02.png)
146+
147+
a. In the **Entity ID** text box, type `cake.hr`.
148+
149+
b. In the **Authentication URL** text box, paste the value of **Login URL**, which you have copied from Azure portal.
150+
151+
c. In the **Key fingerprint (SHA1 format)** text box, paste the **THUMBPRINT** value, which you have copied from Azure portal.
152+
153+
d. Check the **Enable Single Sign on** box.
154+
155+
e. Click **Save**.
156+
157+
### Create CakeHR test user
158+
159+
To enable Azure AD users to sign in to CakeHR, they must be provisioned into CakeHR. In CakeHR, provisioning is a manual task.
160+
161+
**To provision a user account, perform the following steps:**
162+
163+
1. Sign in to CakeHR as a Security Administrator.
164+
165+
2. From the left side of the menu bar, click on **COMPANY** > **ADD**.
166+
167+
![CakeHR configuration](./media/cakehr-tutorial/config03.png)
168+
169+
3. On the **Add new employee** pop-up, perform the following steps:
170+
171+
![CakeHR configuration](./media/cakehr-tutorial/config04.png)
172+
173+
a. In **Full name** text box, enter the name of user like B.Simon.
174+
175+
b. In **Work email** text box, enter the email of user like `[email protected]`.
176+
177+
c. Click **CREATE ACCOUNT**.
178+
179+
## Test SSO
180+
181+
In this section, you test your Azure AD single sign-on configuration using the Access Panel.
182+
183+
When you click the CakeHR tile in the Access Panel, you should be automatically signed in to the CakeHR 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).
184+
185+
## Additional resources
186+
187+
- [ 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)
188+
189+
- [What is application access and single sign-on with Azure Active Directory? ](https://docs.microsoft.com/azure/active-directory/active-directory-appssoaccess-whatis)
190+
191+
- [What is conditional access in Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/conditional-access/overview)
192+
193+
- [Try CakeHR with Azure AD](https://aad.portal.azure.com/)
194+
4.95 KB
Loading
28.7 KB
Loading
17.5 KB
Loading
22.8 KB
Loading

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,8 @@
221221
items:
222222
- name: CA PPM
223223
href: cappm-tutorial.md
224+
- name: CakeHR
225+
href: cakehr-tutorial.md
224226
- name: Canvas Lms
225227
href: canvas-lms-tutorial.md
226228
- name: Capriza Platform

0 commit comments

Comments
 (0)