|
| 1 | +--- |
| 2 | +title: 'Tutorial: Configure Klaxoon 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 Klaxoon. |
| 4 | +services: active-directory |
| 5 | +documentationcenter: '' |
| 6 | +author: twimmer |
| 7 | +writer: Thwimmer |
| 8 | +manager: beatrizd |
| 9 | + |
| 10 | +ms.assetid: b7a61926-171c-415b-858f-54f6e53515f2 |
| 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: article |
| 17 | +ms.date: 09/22/2021 |
| 18 | +ms.author: Thwimmer |
| 19 | +--- |
| 20 | + |
| 21 | +# Tutorial: Configure Klaxoon for automatic user provisioning |
| 22 | + |
| 23 | +This tutorial describes the steps you need to perform in both Klaxoon and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to [Klaxoon](https://www.Klaxoon.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). |
| 24 | + |
| 25 | + |
| 26 | +## Capabilities supported |
| 27 | +> [!div class="checklist"] |
| 28 | +> * Create users in Klaxoon. |
| 29 | +> * Disable users in Klaxoon when they do not require access anymore. |
| 30 | +> * Keep user attributes synchronized between Azure AD and Klaxoon. |
| 31 | +> * Provide licenses to users in Klaxoon based on Azure AD Groups. |
| 32 | +> * [Single sign-on](klaxoon-saml-tutorial.md) to Klaxoon (recommended). |
| 33 | +
|
| 34 | +## Prerequisites |
| 35 | + |
| 36 | +The scenario outlined in this tutorial assumes that you already have the following prerequisites: |
| 37 | + |
| 38 | +* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md). |
| 39 | +* 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). |
| 40 | +* An existing [Klaxoon contract](https://klaxoon.com/enterprise). |
| 41 | + |
| 42 | +## Step 1. Plan your provisioning deployment |
| 43 | +1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md). |
| 44 | +1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 45 | +1. Determine what data to [map between Azure AD and Klaxoon](../app-provisioning/customize-application-attributes.md). |
| 46 | + |
| 47 | +## Step 2. Configure Klaxoon to support provisioning with Azure AD |
| 48 | + |
| 49 | +* Contact [Klaxoon](https://klaxoon.com/) to receive a unique **Tenant URL** and a **Secret Token**. |
| 50 | + |
| 51 | +## Step 3. Add Klaxoon from the Azure AD application gallery |
| 52 | + |
| 53 | +Add Klaxoon from the Azure AD application gallery to start managing provisioning to Klaxoon. If you have previously setup Klaxoon 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). |
| 54 | + |
| 55 | +## Step 4. Define who will be in scope for provisioning |
| 56 | + |
| 57 | +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 / group. 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 and groups to the application. If you choose to scope who will be provisioned based solely on attributes of the user or group, you can use a scoping filter as described [here](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 58 | + |
| 59 | +* When assigning users and groups to Klaxoon, you must select a role other than **Default Access**. Users with the Default Access role are excluded from provisioning and will be marked as not effectively entitled in the provisioning logs. If the only role available on the application is the default access role, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add additional roles. |
| 60 | + |
| 61 | +* Start small. Test with a small set of users and groups before rolling out to everyone. When scope for provisioning is set to assigned users and groups, you can control this by assigning one or two users or groups to the app. When scope is set to all users and groups, you can specify an [attribute based scoping filter](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md). |
| 62 | + |
| 63 | + |
| 64 | +## Step 5. Configure automatic user provisioning to Klaxoon |
| 65 | + |
| 66 | +This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in Klaxoon based on user and/or group assignments in Azure AD. |
| 67 | + |
| 68 | +### To configure automatic user provisioning for Klaxoon in Azure AD: |
| 69 | + |
| 70 | +1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**. |
| 71 | + |
| 72 | +  |
| 73 | + |
| 74 | +1. In the applications list, select **Klaxoon**. |
| 75 | + |
| 76 | +  |
| 77 | + |
| 78 | +1. Select the **Provisioning** tab. |
| 79 | + |
| 80 | +  |
| 81 | + |
| 82 | +1. Set the **Provisioning Mode** to **Automatic**. |
| 83 | + |
| 84 | +  |
| 85 | + |
| 86 | +1. Under the **Admin Credentials** section, input your Klaxoon Tenant URL and Secret Token provided by Klaxoon. Click **Test Connection** to ensure Azure AD can connect to Klaxoon. If the connection fails, please contact Klaxoon to check your account setup. |
| 87 | + |
| 88 | +  |
| 89 | + |
| 90 | +1. In the **Notification Email** field, enter the email address of a person or group who should receive the provisioning error notifications and select the **Send an email notification when a failure occurs** check box. |
| 91 | + |
| 92 | +  |
| 93 | + |
| 94 | +1. Select **Save**. |
| 95 | + |
| 96 | +1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Klaxoon**. |
| 97 | + |
| 98 | +1. Review the user attributes that are synchronized from Azure AD to Klaxoon in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Klaxoon 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 Klaxoon API supports filtering users based on that attribute. Select the **Save** button to commit any changes. |
| 99 | + |
| 100 | + |Attribute|Type|Supported for filtering|Required by Klaxoon| |
| 101 | + |---|---|---|---| |
| 102 | + |userName|String|✓|✓| |
| 103 | + |emails[type eq "work"].value|String|✓|✓| |
| 104 | + |externalId|String||✓| |
| 105 | + |name.givenName|String||✓| |
| 106 | + |name.familyName|String||✓| |
| 107 | + |active|Boolean||✓| |
| 108 | + |
| 109 | +1. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to Klaxoon**. |
| 110 | + |
| 111 | +1. Review the group attributes that are synchronized from Azure AD to Klaxoon in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the groups in Klaxoon for update operations. Select the **Save** button to commit any changes. |
| 112 | + |
| 113 | + |Attribute|Type|Supported for filtering|Required by Klaxoon| |
| 114 | + |---|---|---|---| |
| 115 | + |displayName|String|✓|✓ |
| 116 | + |externalId|String||✓ |
| 117 | + |members|Reference|| |
| 118 | + |urn:ietf:params:scim:schemas:extension:klaxoon:2.0:Group:license|String|| |
| 119 | + |
| 120 | + |
| 121 | +1. Define **urn:ietf:params:scim:schemas:extension:klaxoon:2.0:Group:license** attribute to provide Klaxoon PRO licenses to users linked to a group. |
| 122 | + |
| 123 | + |Value|Group with Klaxoon PRO license| |
| 124 | + |---|---| |
| 125 | + |true|✓| |
| 126 | + |false|No| |
| 127 | + |not specified (default value)|✓| |
| 128 | + |
| 129 | +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). |
| 130 | + |
| 131 | +1. To enable the Azure AD provisioning service for Klaxoon, change the **Provisioning Status** to **On** in the **Settings** section. |
| 132 | + |
| 133 | +  |
| 134 | + |
| 135 | +1. Define the users and/or groups that you would like to provision to Klaxoon by choosing the desired values in **Scope** in the **Settings** section. |
| 136 | + |
| 137 | +  |
| 138 | + |
| 139 | +1. When you are ready to provision, click **Save**. |
| 140 | + |
| 141 | +  |
| 142 | + |
| 143 | +This operation starts the initial synchronization cycle of all users and groups 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. |
| 144 | + |
| 145 | +## Step 6. Monitor your deployment |
| 146 | +Once you've configured provisioning, use the following resources to monitor your deployment: |
| 147 | + |
| 148 | +* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully |
| 149 | +* 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 |
| 150 | +* 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). |
| 151 | + |
| 152 | +## More resources |
| 153 | + |
| 154 | +* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md) |
| 155 | +* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md) |
| 156 | + |
| 157 | +## Next steps |
| 158 | + |
| 159 | +* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md) |
0 commit comments