Skip to content

Commit 09c0b9d

Browse files
authored
Merge pull request #246458 from Harshita-130901/Airbase
Publishing new Document.
2 parents 8e58540 + 7cc8fc6 commit 09c0b9d

File tree

4 files changed

+411
-0
lines changed

4 files changed

+411
-0
lines changed
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
title: 'Tutorial: Configure Airbase for automatic user provisioning with Azure Active Directory'
3+
description: Learn how to automatically provision and de-provision user accounts from Azure AD to Airbase.
4+
services: active-directory
5+
author: twimmers
6+
writer: twimmers
7+
manager: jeedes
8+
ms.assetid: 1388651c-4527-49bc-97d3-6fbdd203d37f
9+
ms.service: active-directory
10+
ms.subservice: saas-app-tutorial
11+
ms.workload: identity
12+
ms.topic: tutorial
13+
ms.date: 07/26/2023
14+
ms.author: thwimmer
15+
---
16+
17+
# Tutorial: Configure Airbase for automatic user provisioning
18+
19+
This tutorial describes the steps you need to perform in both Airbase and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users to [Airbase](https://www.airbase.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).
20+
21+
22+
## Supported capabilities
23+
> [!div class="checklist"]
24+
> * Create users in Airbase.
25+
> * Remove users in Airbase when they do not require access anymore.
26+
> * Keep user attributes synchronized between Azure AD and Airbase.
27+
> * [Single sign-on](airbase-tutorial.md) to Airbase (recommended).
28+
29+
## Prerequisites
30+
31+
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
32+
33+
* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md)
34+
* 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).
35+
* A user account in Airbase with Admin permissions.
36+
37+
## Step 1. Plan your provisioning deployment
38+
* Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md).
39+
* Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
40+
* Determine what data to [map between Azure AD and Airbase](../app-provisioning/customize-application-attributes.md).
41+
42+
## Step 2. Configure Airbase to support provisioning with Azure AD
43+
Contact Airbase support to configure Airbase to support provisioning with Azure AD.
44+
45+
## Step 3. Add Airbase from the Azure AD application gallery
46+
47+
Add Airbase from the Azure AD application gallery to start managing provisioning to Airbase. If you have previously setup Airbase for SSO you can use the same application. However it's 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).
48+
49+
## Step 4. Define who will be in scope for provisioning
50+
51+
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).
52+
53+
* 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).
54+
55+
* If you need more roles, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add new roles.
56+
57+
58+
## Step 5. Configure automatic user provisioning to Airbase
59+
60+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users in TestApp based on user assignments in Azure AD.
61+
62+
### To configure automatic user provisioning for Airbase in Azure AD:
63+
64+
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
65+
66+
![Screenshot of Enterprise applications blade.](common/enterprise-applications.png)
67+
68+
1. In the applications list, select **Airbase**.
69+
70+
![Screenshot of the Airbase link in the Applications list.](common/all-applications.png)
71+
72+
1. Select the **Provisioning** tab.
73+
74+
![Screenshot of Provisioning tab.](common/provisioning.png)
75+
76+
1. Set the **Provisioning Mode** to **Automatic**.
77+
78+
![Screenshot of Provisioning tab automatic.](common/provisioning-automatic.png)
79+
80+
1. Under the **Admin Credentials** section, input your Airbase Tenant URL and Secret Token. Click **Test Connection** to ensure Azure AD can connect to Airbase. If the connection fails, ensure your Airbase account has Admin permissions and try again.
81+
82+
![Screenshot of Token.](common/provisioning-testconnection-tenanturltoken.png)
83+
84+
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.
85+
86+
![Screenshot of Notification Email.](common/provisioning-notification-email.png)
87+
88+
1. Select **Save**.
89+
90+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Airbase**.
91+
92+
1. Review the user attributes that are synchronized from Azure AD to Airbase in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Airbase for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you'll need to ensure that the Airbase API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
93+
94+
|Attribute|Type|Supported for filtering|Required by Airbase|
95+
|---|---|---|---|
96+
|userName|String|✓|✓
97+
|active|Boolean||✓
98+
|emails[type eq "work"].value|String||✓
99+
|name.givenName|String||
100+
|name.familyName|String||
101+
|externalId|String||✓
102+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department|String||
103+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager|Reference||
104+
|urn:ietf:params:scim:schemas:extension:airbase:2.0:User:accountingPolicy|String||
105+
|urn:ietf:params:scim:schemas:extension:airbase:2.0:User:subsidiary|String||
106+
|urn:ietf:params:scim:schemas:extension:airbase:2.0:User:role|String||
107+
108+
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).
109+
110+
1. To enable the Azure AD provisioning service for Airbase, change the **Provisioning Status** to **On** in the **Settings** section.
111+
112+
![Screenshot of Provisioning Status Toggled On.](common/provisioning-toggle-on.png)
113+
114+
1. Define the users that you would like to provision to Airbase by choosing the desired values in **Scope** in the **Settings** section.
115+
116+
![Screenshot of Provisioning Scope.](common/provisioning-scope.png)
117+
118+
1. When you're ready to provision, click **Save**.
119+
120+
![Screenshot of Saving Provisioning Configuration.](common/provisioning-configuration-save.png)
121+
122+
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.
123+
124+
## Step 6. Monitor your deployment
125+
Once you've configured provisioning, use the following resources to monitor your deployment:
126+
127+
* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully
128+
* 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's to completion
129+
* If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md).
130+
131+
## More resources
132+
133+
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
134+
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
135+
136+
## Next steps
137+
138+
* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md)
Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: 'Tutorial: Configure Kintone for automatic user provisioning with Azure Active Directory'
3+
description: Learn how to automatically provision and de-provision user accounts from Azure AD to Kintone.
4+
services: active-directory
5+
author: twimmers
6+
writer: twimmers
7+
manager: jeedes
8+
ms.assetid: 6c6ccabb-0a15-4a15-ba97-771fd15017d0
9+
ms.service: active-directory
10+
ms.subservice: saas-app-tutorial
11+
ms.workload: identity
12+
ms.topic: tutorial
13+
ms.date: 07/26/2023
14+
ms.author: thwimmer
15+
---
16+
17+
# Tutorial: Configure Kintone for automatic user provisioning
18+
19+
This tutorial describes the steps you need to perform in both Kintone and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users to [Kintone](https://www.kintone.com/en-us/) 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).
20+
21+
22+
## Supported capabilities
23+
> [!div class="checklist"]
24+
> * Create users in Kintone.
25+
> * Remove users in Kintone when they do not require access anymore.
26+
> * Keep user attributes synchronized between Azure AD and Kintone.
27+
> * [Single sign-on](kintone-tutorial.md) to Kintone (recommended).
28+
29+
## Prerequisites
30+
31+
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
32+
33+
* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md)
34+
* 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).
35+
* A user account in Kintone with Admin permissions.
36+
37+
## Step 1. Plan your provisioning deployment
38+
* Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md).
39+
* Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
40+
* Determine what data to [map between Azure AD and Kintone](../app-provisioning/customize-application-attributes.md).
41+
42+
## Step 2. Configure Kintone to support provisioning with Azure AD
43+
Contact Kintone support to configure Kintone to support provisioning with Azure AD.
44+
45+
## Step 3. Add Kintone from the Azure AD application gallery
46+
47+
Add Kintone from the Azure AD application gallery to start managing provisioning to Kintone. If you have previously setup Kintone for SSO you can use the same application. However it's 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).
48+
49+
## Step 4. Define who will be in scope for provisioning
50+
51+
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).
52+
53+
* 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).
54+
55+
* If you need more roles, you can [update the application manifest](../develop/howto-add-app-roles-in-azure-ad-apps.md) to add new roles.
56+
57+
58+
## Step 5. Configure automatic user provisioning to Kintone
59+
60+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users in TestApp based on user assignments in Azure AD.
61+
62+
### To configure automatic user provisioning for Kintone in Azure AD:
63+
64+
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
65+
66+
![Screenshot of Enterprise applications blade.](common/enterprise-applications.png)
67+
68+
1. In the applications list, select **Kintone**.
69+
70+
![Screenshot of the Kintone link in the Applications list.](common/all-applications.png)
71+
72+
1. Select the **Provisioning** tab.
73+
74+
![Screenshot of Provisioning tab.](common/provisioning.png)
75+
76+
1. Set the **Provisioning Mode** to **Automatic**.
77+
78+
![Screenshot of Provisioning tab automatic.](common/provisioning-automatic.png)
79+
80+
1. Under the **Admin Credentials** section, input your Kintone Tenant URL and Secret Token. Click **Test Connection** to ensure Azure AD can connect to Kintone. If the connection fails, ensure your Kintone account has Admin permissions and try again.
81+
82+
![Screenshot of Token.](common/provisioning-testconnection-tenanturltoken.png)
83+
84+
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.
85+
86+
![Screenshot of Notification Email.](common/provisioning-notification-email.png)
87+
88+
1. Select **Save**.
89+
90+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Kintone**.
91+
92+
1. Review the user attributes that are synchronized from Azure AD to Kintone in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Kintone for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you'll need to ensure that the Kintone API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
93+
94+
|Attribute|Type|Supported for filtering|Required by Kintone|
95+
|---|---|---|---|
96+
|userName|String|✓|✓
97+
|active|Boolean||
98+
|displayName|String||
99+
|emails[type eq "work"].value|String||
100+
|name.givenName|String||
101+
|name.familyName|String||
102+
|externalId|String||
103+
104+
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).
105+
106+
1. To enable the Azure AD provisioning service for Kintone, change the **Provisioning Status** to **On** in the **Settings** section.
107+
108+
![Screenshot of Provisioning Status Toggled On.](common/provisioning-toggle-on.png)
109+
110+
1. Define the users that you would like to provision to Kintone by choosing the desired values in **Scope** in the **Settings** section.
111+
112+
![Screenshot of Provisioning Scope.](common/provisioning-scope.png)
113+
114+
1. When you're ready to provision, click **Save**.
115+
116+
![Screenshot of Saving Provisioning Configuration.](common/provisioning-configuration-save.png)
117+
118+
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.
119+
120+
## Step 6. Monitor your deployment
121+
Once you've configured provisioning, use the following resources to monitor your deployment:
122+
123+
* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully
124+
* 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's to completion
125+
* If the provisioning configuration seems to be in an unhealthy state, the application goes into quarantine. Learn more about quarantine states [here](../app-provisioning/application-provisioning-quarantine-status.md).
126+
127+
## More resources
128+
129+
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
130+
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
131+
132+
## Next steps
133+
134+
* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md)

0 commit comments

Comments
 (0)