Skip to content

Commit f973ffb

Browse files
v-dirichardsv-dirichards
authored
Merge pull request #227734 from v-missam/atmos1
Atmos1
2 parents 7bacda5 + e4906f0 commit f973ffb

File tree

2 files changed

+156
-0
lines changed

2 files changed

+156
-0
lines changed

‎articles/active-directory/saas-apps/atmos-provisioning-tutorial.md

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
---
2+
title: 'Tutorial: Configure Atmos 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 Atmos.
4+
services: active-directory
5+
author: twimmers
6+
writer: twimmers
7+
manager: beatrizd
8+
9+
ms.assetid: 769b98d7-009f-44ed-8569-a5acc52d7552
10+
ms.service: active-directory
11+
ms.subservice: saas-app-tutorial
12+
ms.workload: identity
13+
ms.topic: tutorial
14+
ms.date: 02/14/2023
15+
ms.author: thwimmer
16+
---
17+
18+
# Tutorial: Configure Atmos for automatic user provisioning
19+
20+
This tutorial describes the steps you need to do in both Atmos and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to [Atmos](https://www.axissecurity.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).
21+
22+
23+
## Capabilities Supported
24+
> [!div class="checklist"]
25+
> * Create users in Atmos.
26+
> * Remove users in Atmos when they do not require access anymore.
27+
> * Keep user attributes synchronized between Azure AD and Atmos.
28+
> * Provision groups and group memberships in Atmos.
29+
30+
## Prerequisites
31+
32+
The scenario outlined in this tutorial assumes that you already have the following prerequisites:
33+
34+
* [An Azure AD tenant](../develop/quickstart-create-new-tenant.md).
35+
* 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).
36+
* A user account in [Axis Security](https://www.axissecurity.com) with Admin permissions.
37+
38+
## Step 1. Plan your provisioning deployment
39+
1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md).
40+
1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
41+
1. Determine what data to [map between Azure AD and Atmos](../app-provisioning/customize-application-attributes.md).
42+
43+
## Step 2. Configure Atmos to support provisioning with Azure AD
44+
45+
1. Log in to the [Management Console](https://auth.axissecurity.com/).
46+
1. Navigate to **Settings**-> **Identity Providers** screen.
47+
1. Hover over the **Azure Identity Provider** and select **edit**.
48+
1. Navigate to **Advanced Settings**.
49+
1. Navigate to **User Auto-Provisioning (SCIM)**.
50+
1. Click **Generate new token**.
51+
1. Copy the **SCIM Service Provider Endpoint** and **SCIM Provisioning Token** and paste them into a text editor. You need them for Step 5.
52+
53+
## Step 3. Add Atmos from the Azure AD application gallery
54+
55+
Add Atmos from the Azure AD application gallery to start managing provisioning to Atmos. If you have previously setup Atmos for SSO, you can use the same application. However the recommendation is to 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).
56+
57+
## Step 4. Define who will be in scope for provisioning
58+
59+
The Azure AD provisioning service allows you to scope provisioning based on assignment to the application and or based on attributes of the user / group. If you choose to scope provisioning 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 provisioning 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).
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+
* 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.
64+
65+
66+
## Step 5. Configure automatic user provisioning to Atmos
67+
68+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and groups in Atmos based on user and/or group assignments in Azure AD.
69+
70+
### To configure automatic user provisioning for Atmos in Azure AD:
71+
72+
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
73+
74+
![Screenshot of enterprise applications blade.](common/enterprise-applications.png)
75+
76+
1. In the applications list, select **Atmos**.
77+
78+
![Screenshot of the Atmos link in the Applications list.](common/all-applications.png)
79+
80+
1. Select the **Provisioning** tab.
81+
82+
![Screenshot of Provisioning tab.](common/provisioning.png)
83+
84+
1. Set the **Provisioning Mode** to **Automatic**.
85+
86+
![Screenshot of Provisioning tab automatic.](common/provisioning-automatic.png)
87+
88+
1. In the **Admin Credentials** section, paste the **SCIM Service Provider Endpoint** obtained from the Axis SCIM configuration (step 2) in Tenant URL, and paste the **SCIM Provisioning Token** obtained from the Axis SCIM configuration (step 2) in **Secret Token**. Click **Test Connection** to ensure Azure AD can connect to Atmos. If the connection fails, contact Axis to check your account setup.
89+
90+
![Screenshot of Token.](common/provisioning-testconnection-tenanturltoken.png)
91+
92+
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.
93+
94+
![Screenshot of Notification Email.](common/provisioning-notification-email.png)
95+
96+
1. Select **Save**.
97+
98+
1. In the **Mappings** section, select **Synchronize Azure Active Directory Users to Atmos**.
99+
100+
1. Review the synchronized user attributes from Azure AD to Atmos, in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Atmos for update operations. If you choose to change the [matching target attribute](../app-provisioning/customize-application-attributes.md), you need to ensure that the Atmos API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
101+
102+
|Attribute|Type|Supported for filtering|Required by Atmos|
103+
|---|---|---|---|
104+
|userName|String|✓|✓|
105+
|active|Boolean|||
106+
|displayName|String||✓|
107+
|emails[type eq "work"].value|String|||
108+
|name.givenName|String|||
109+
|name.familyName|String|||
110+
|externalId|String|||
111+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department|String|||
112+
|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division|String|||
113+
114+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to Atmos**.
115+
116+
1. Review the synchronized group attributes from Azure AD to Atmos, in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the groups in Atmos for update operations. Select the **Save** button to commit any changes.
117+
118+
|Attribute|Type|Supported for filtering|Required by Atmos|
119+
|---|---|---|---|
120+
|displayName|String|✓|✓
121+
|members|Reference||
122+
|externalId|String||✓
123+
124+
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).
125+
126+
1. To enable the Azure AD provisioning service for Atmos, change the **Provisioning Status** to **On** in the **Settings** section.
127+
128+
![Screenshot of Provisioning Status Toggled On.](common/provisioning-toggle-on.png)
129+
130+
1. Define the users and groups that you would like to provision to Atmos by choosing the appropriate values in **Scope** in the **Settings** section.
131+
132+
![Screenshot of Provisioning Scope.](common/provisioning-scope.png)
133+
134+
1. When you're ready to provision, click **Save**.
135+
136+
![Screenshot of Saving Provisioning Configuration.](common/provisioning-configuration-save.png)
137+
138+
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 execute than next cycles, which occur approximately every 40 minutes as long as the Azure AD provisioning service is running.
139+
140+
## Step 6. Monitor your deployment
141+
Once you've configured provisioning, use the following resources to monitor your deployment:
142+
143+
* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users provisioned successfully or unsuccessfully
144+
* 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
145+
* 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).
146+
147+
## More resources
148+
149+
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
150+
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
151+
152+
## Next steps
153+
154+
* [Learn how to review logs and get reports on provisioning activity](../app-provisioning/check-status-user-account-provisioning.md)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2834,6 +2834,8 @@
28342834
href: atea-provisioning-tutorial.md
28352835
- name: Atlassian Cloud
28362836
href: atlassian-cloud-provisioning-tutorial.md
2837+
- name: Atmos
2838+
href: atmos-provisioning-tutorial.md
28372839
- name: AuditBoard
28382840
href: auditboard-provisioning-tutorial.md
28392841
- name: Autodesk SSO

0 commit comments

Comments
 (0)