|
| 1 | +--- |
| 2 | +title: 'Tutorial: Configure Keepabl for automatic user provisioning with Azure Active Directory | Microsoft Docs' |
| 3 | +description: Learn how to automatically provision and de-provision user accounts from Azure AD to Keepabl. |
| 4 | +services: active-directory |
| 5 | +documentationcenter: '' |
| 6 | +author: twimmers |
| 7 | +writer: Thwimmer |
| 8 | +manager: beatrizd |
| 9 | + |
| 10 | +ms.assetid: 80b48f18-fbdd-4c35-8aa9-b5f7a8331044 |
| 11 | +ms.service: active-directory |
| 12 | +ms.subservice: saas-app-tutorial |
| 13 | +ms.workload: identity |
| 14 | +ms.devlang: na |
| 15 | +ms.topic: tutorial |
| 16 | +ms.date: 10/25/2022 |
| 17 | +ms.author: Thwimmer |
| 18 | +--- |
| 19 | + |
| 20 | +# Tutorial: Configure Keepabl for automatic user provisioning |
| 21 | + |
| 22 | +This tutorial describes the steps you need to perform in both Keepabl and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users to [Keepabl](https://keepabl.com/) using the Azure AD Provisioning service. For important details on what this service does, how it works, and frequently asked questions, see [Automate user provisioning and deprovisioning to SaaS applications with Azure Active Directory](../app-provisioning/user-provisioning.md). |
| 23 | + |
| 24 | + |
| 25 | +## Capabilities supported |
| 26 | +> [!div class="checklist"] |
| 27 | +> * Create users in Keepabl. |
| 28 | +> * Remove users in Keepabl when they do not require access anymore. |
| 29 | +> * Keep user attributes synchronized between Azure AD and Keepabl. |
| 30 | +> * [Single sign-on](keepabl-tutorial.md) to Keepabl (recommended). |
| 31 | +
|
| 32 | +## Prerequisites |
| 33 | + |
| 34 | +The scenario outlined in this tutorial assumes that you already have the following prerequisites: |
| 35 | + |
| 36 | +* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md). |
| 37 | +* A user account in Azure AD with [permission](../roles/permissions-reference.md) to configure provisioning (for example, Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator). |
| 38 | +* A user account in Keepabl with Admin permissions. |
| 39 | + |
| 40 | + |
| 41 | +## Step 1. Plan your provisioning deployment |
| 42 | +1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md). |
| 43 | +1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 44 | +1. Determine what data to [map between Azure AD and Keepabl](../app-provisioning/customize-application-attributes.md). |
| 45 | + |
| 46 | +## Step 2. Configure Keepabl to support provisioning with Azure AD |
| 47 | + |
| 48 | +1. Sign in to [Keepabl Admin Portal](https://app.keepabl.com) and then navigate to **Account Settings > Your Organization**, where you’ll see the **Single Sign-On (SSO)** section. |
| 49 | +1. Click on the **Edit Identity Provider** button.You will be taken to the SSO Setup page, where once you select Microsoft Azure as your provider and then scroll down, you will see your **Tenant URL** and **Secret Token**. These value will be entered in the Provisioning tab of your Keepabl application in the Azure portal. |
| 50 | + |
| 51 | +  |
| 52 | + |
| 53 | +>[!NOTE] |
| 54 | +>To Setup Identity Provider or SSO visit [here](https://keepabl.com/admin-guide-to-sso-keepabl). |
| 55 | +
|
| 56 | +## Step 3. Add Keepabl from the Azure AD application gallery |
| 57 | + |
| 58 | +Add Keepabl from the Azure AD application gallery to start managing provisioning to Keepabl. If you have previously setup Keepabl for SSO, you can use the same application. However it is recommended that you create a separate app when testing out the integration initially. Learn more about adding an application from the gallery [here](../manage-apps/add-application-portal.md). |
| 59 | + |
| 60 | +## Step 4. Define who will be in scope for provisioning |
| 61 | + |
| 62 | +The Azure AD provisioning service allows you to scope who will be provisioned based on assignment to the application and or based on attributes of the user. If you choose to scope who will be provisioned to your app based on assignment, you can use the following [steps](../manage-apps/assign-user-or-group-access-portal.md) to assign users to the application. If you choose to scope who will be provisioned based solely on attributes of the user, you can use a scoping filter as described [here](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 63 | + |
| 64 | +* Start small. Test with a small set of users before rolling out to everyone. When scope for provisioning is set to assigned users, you can control this by assigning one or two users to the app. When scope is set to all users, you can specify an [attribute based scoping filter](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 65 | + |
| 66 | +* If you need additional roles, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add new roles. |
| 67 | + |
| 68 | +## Step 5. Configure automatic user provisioning to Keepabl |
| 69 | + |
| 70 | +This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users in Keepabl based on user assignments in Azure AD. |
| 71 | + |
| 72 | +### To configure automatic user provisioning for Keepabl in Azure AD: |
| 73 | + |
| 74 | +1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**. |
| 75 | + |
| 76 | +  |
| 77 | + |
| 78 | +1. In the applications list, select **Keepabl**. |
| 79 | + |
| 80 | +  |
| 81 | + |
| 82 | +1. Select the **Provisioning** tab. |
| 83 | + |
| 84 | +  |
| 85 | + |
| 86 | +1. Set the **Provisioning Mode** to **Automatic**. |
| 87 | + |
| 88 | +  |
| 89 | + |
| 90 | +1. Under the **Admin Credentials** section, input your Keepabl Tenant URL and corresponding Secret Token. Click **Test Connection** to ensure Azure AD can connect to Keepabl. |
| 91 | + |
| 92 | +  |
| 93 | + |
| 94 | +1. In the **Notification Email** field, enter the email address of a person who should receive the provisioning error notifications and select the **Send an email notification when a failure occurs** check box. |
| 95 | + |
| 96 | +  |
| 97 | + |
| 98 | +1. Select **Save**. |
| 99 | + |
| 100 | +1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Keepabl**. |
| 101 | + |
| 102 | +1. Review the user attributes that are synchronized from Azure AD to Keepabl in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Keepabl for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you will need to ensure that the Keepabl API supports filtering users based on that attribute. Select the **Save** button to commit any changes. |
| 103 | + |
| 104 | + |Attribute|Type|Supported for filtering|Required by Keepabl| |
| 105 | + |---|---|---|---| |
| 106 | + |userName|String|✓|✓ |
| 107 | + |emails[type eq "work"].value|String|✓|✓ |
| 108 | + |active|Boolean||| |
| 109 | + |name.givenName|String||| |
| 110 | + |name.familyName|String||| |
| 111 | + |
| 112 | +1. To configure scoping filters, refer to the following instructions provided in the [Scoping filter tutorial](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 113 | + |
| 114 | +1. To enable the Azure AD provisioning service for Keepabl, change the **Provisioning Status** to **On** in the **Settings** section. |
| 115 | + |
| 116 | +  |
| 117 | + |
| 118 | +1. Define the users that you would like to provision to Keepabl by choosing the desired values in **Scope** in the **Settings** section. |
| 119 | + |
| 120 | +  |
| 121 | + |
| 122 | +1. When you are ready to provision, click **Save**. |
| 123 | + |
| 124 | +  |
| 125 | + |
| 126 | +This operation starts the initial synchronization cycle of all users defined in **Scope** in the **Settings** section. The initial cycle takes longer to perform than subsequent cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running. |
| 127 | + |
| 128 | +## Step 6. Monitor your deployment |
| 129 | +Once you've configured provisioning, use the following resources to monitor your deployment: |
| 130 | + |
| 131 | +* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully |
| 132 | +* Check the [progress bar](../app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user.md) to see the status of the provisioning cycle and how close it is to completion |
| 133 | +* If the provisioning configuration seems to be in an unhealthy state, the application will go into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md). |
| 134 | + |
| 135 | +## More resources |
| 136 | + |
| 137 | +* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md) |
| 138 | +* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md) |
| 139 | + |
| 140 | +## Next steps |
| 141 | + |
| 142 | +* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md) |
0 commit comments