Skip to content

Commit bb78eed

Browse files
v-ccolinv-ccolin
authored
Merge pull request #229240 from v-missam/akamai
doc-1
2 parents c5826d2 + d6c099e commit bb78eed

File tree

2 files changed

+169
-0
lines changed

2 files changed

+169
-0
lines changed

‎articles/active-directory/saas-apps/akamai-enterprise-application-access-provisioning-tutorial.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
title: 'Tutorial: Configure Akamai Enterprise Application Access 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 Akamai Enterprise Application Access.
4+
services: active-directory
5+
author: twimmers
6+
writer: twimmers
7+
manager: beatrizd
8+
ms.assetid: e4eb183a-192f-49e0-8724-549b2f360b8e
9+
ms.service: active-directory
10+
ms.subservice: saas-app-tutorial
11+
ms.workload: identity
12+
ms.topic: tutorial
13+
ms.date: 02/27/2023
14+
ms.author: thwimmer
15+
---
16+
17+
# Tutorial: Configure Akamai Enterprise Application Access for automatic user provisioning
18+
19+
This tutorial describes the steps you need to perform in both Akamai Enterprise Application Access and Azure Active Directory (Azure AD) to configure automatic user provisioning. When configured, Azure AD automatically provisions and de-provisions users and groups to [Akamai Enterprise Application Access](https://www.akamai.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 Akamai Enterprise Application Access.
25+
> * Remove users in Akamai Enterprise Application Access when they do not require access anymore.
26+
> * Keep user attributes synchronized between Azure AD and Akamai Enterprise Application Access.
27+
> * Provision groups and group memberships in Akamai Enterprise Application Access
28+
> * [Single sign-on](akamai-tutorial.md) to Akamai Enterprise Application Access (recommended).
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 (e.g. Application Administrator, Cloud Application administrator, Application Owner, or Global Administrator).
36+
* An administrator account with Akamai [Enterprise Application Access](https://www.akamai.com/products/enterprise-application-access).
37+
38+
39+
## Step 1. Plan your provisioning deployment
40+
1. Learn about [how the provisioning service works](../app-provisioning/user-provisioning.md).
41+
1. Determine who will be in [scope for provisioning](../app-provisioning/define-conditional-rules-for-provisioning-user-accounts.md).
42+
1. Determine what data to [map between Azure AD and Akamai Enterprise Application Access](../app-provisioning/customize-application-attributes.md).
43+
44+
## Step 2. Configure Akamai Enterprise Application Access to support provisioning with Azure AD
45+
46+
Configure a SCIM directory of type Azure in Akamai Enterprise Center and save the SCIM base URL and the Provisioning key.
47+
48+
1. Sign in to [Akamai Enterprise Center](https://control.akamai.com/apps/zt-ui/#/identity/directories).
49+
50+
1. In menu, navigate to **Application Access > Identity & Users > Directories**.
51+
1. Select **Add New Directory** (+).
52+
1. Enter a name and description for directory.
53+
1. In **Directory Type** select **SCIM**, and in **SCIM Schema** select **Azure**.
54+
1. Select **Add New Directory**.
55+
1. Open your new directory **Settings** > **General** and copy **SCIM base URL**. Save it for Azure SCIM provisioning in STEP 4.
56+
1. In **Settings** > **General** select **Create Provisioning Key**.
57+
1. Enter a name and description for the key.
58+
1. Copy **Provisioning key** by clicking on the copy to clipboard icon. Save it for Azure SCIM provisioning in STEP 5.
59+
1. In **Login preference Attributes** select either **User principal name** (default) or **Email** to choose for a user a way to log in.
60+
1. Select **Save**.
61+
The new SCIM directory appears in the directories list in **Identity & Users** > **Directories**.
62+
63+
64+
## Step 3. Add Akamai Enterprise Application Access from the Azure AD application gallery
65+
66+
Add Akamai Enterprise Application Access from the Azure AD application gallery to start managing provisioning to Akamai Enterprise Application Access. If you have previously setup Akamai Enterprise Application Access 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).
67+
68+
## Step 4. Define who will be in scope for provisioning
69+
70+
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).
71+
72+
* 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).
73+
74+
* 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.
75+
76+
77+
## Step 5. Configure automatic user provisioning to Akamai Enterprise Application Access
78+
79+
This section guides you through the steps to configure the Azure AD provisioning service to create, update, and disable users and/or groups in TestApp based on user and/or group assignments in Azure AD.
80+
81+
### To configure automatic user provisioning for Akamai Enterprise Application Access in Azure AD:
82+
83+
1. Sign in to the [Azure portal](https://portal.azure.com). Select **Enterprise Applications**, then select **All applications**.
84+
85+
![Screenshot of Enterprise applications blade.](common/enterprise-applications.png)
86+
87+
1. In the applications list, select **Akamai Enterprise Application Access**.
88+
89+
![Screenshot of the Akamai Enterprise Application Access link in the Applications list.](common/all-applications.png)
90+
91+
1. Select the **Provisioning** tab.
92+
93+
![Screenshot of Provisioning tab.](common/provisioning.png)
94+
95+
1. Set the **Provisioning Mode** to **Automatic**.
96+
97+
![Screenshot of Provisioning tab automatic.](common/provisioning-automatic.png)
98+
99+
1. Under the **Admin Credentials** section, input your Akamai Enterprise Application Access Tenant URL and Secret Token. Click **Test Connection** to ensure Azure AD can connect to Akamai Enterprise Application Access. If the connection fails, ensure your Akamai Enterprise Application Access account has Admin permissions and try again.
100+
101+
![Screenshot of Token.](common/provisioning-testconnection-tenanturltoken.png)
102+
103+
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.
104+
105+
![Screenshot of Notification Email.](common/provisioning-notification-email.png)
106+
107+
1. Select **Save**.
108+
109+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Users to Akamai Enterprise Application Access**.
110+
111+
1. Review the user attributes that are synchronized from Azure AD to Akamai Enterprise Application Access in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the user accounts in Akamai Enterprise Application Access 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 Akamai Enterprise Application Access API supports filtering users based on that attribute. Select the **Save** button to commit any changes.
112+
113+
|Attribute| Type |Supported for filtering|Required by Akamai Enterprise Application Access|
114+
|---|---|---|---|
115+
|userName| String |✓|✓
116+
|active| Boolean |||
117+
|displayName| String |||
118+
|emails[type eq "work"].value| String ||✓
119+
|name.givenName| String |||
120+
|name.familyName| String |||
121+
|phoneNumbers[type eq "mobile"].value| String|||
122+
|externalId| String |||
123+
124+
125+
1. Under the **Mappings** section, select **Synchronize Azure Active Directory Groups to Akamai Enterprise Application Access**.
126+
127+
1. Review the group attributes that are synchronized from Azure AD to Akamai Enterprise Application Access in the **Attribute-Mapping** section. The attributes selected as **Matching** properties are used to match the groups in Akamai Enterprise Application Access for update operations. Select the **Save** button to commit any changes.
128+
129+
|Attribute|Type|Supported for filtering|Required by Akamai Enterprise Application Access|
130+
|---|---|---|---|
131+
|displayName|String|✓|✓
132+
|externalId|String|||
133+
|members|Reference|||
134+
135+
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).
136+
137+
1. To enable the Azure AD provisioning service for Akamai Enterprise Application Access, change the **Provisioning Status** to **On** in the **Settings** section.
138+
139+
![Screenshot of Provisioning Status Toggled On.](common/provisioning-toggle-on.png)
140+
141+
1. Define the users and/or groups that you would like to provision to Akamai Enterprise Application Access by choosing the desired values in **Scope** in the **Settings** section.
142+
143+
![Screenshot of Provisioning Scope.](common/provisioning-scope.png)
144+
145+
1. When you are ready to provision, click **Save**.
146+
147+
![Screenshot of Saving Provisioning Configuration.](common/provisioning-configuration-save.png)
148+
149+
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.
150+
151+
## Step 6. Monitor your deployment
152+
Once you've configured provisioning, use the following resources to monitor your deployment:
153+
154+
* Use the [provisioning logs](../reports-monitoring/concept-provisioning-logs.md) to determine which users have been provisioned successfully or unsuccessfully
155+
* 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
156+
* 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).
157+
158+
## More resources
159+
160+
* [Managing user account provisioning for Enterprise Apps](../app-provisioning/configure-automatic-user-provisioning-portal.md)
161+
* [What is application access and single sign-on with Azure Active Directory?](../manage-apps/what-is-single-sign-on.md)
162+
* [Akamai Enterprise Application Access - Getting Started](https://techdocs.akamai.com/eaa/docs/welcome-guide)
163+
* [Configuring Custom Attributes in EAA](https://techdocs.akamai.com/eaa/docs/scim-provisioning-with-azure#step-7-optional-add-a-custom-attribute-in--and-map-it-to-the-scim-attribute-in-your--scim-directory)
164+
165+
## Next steps
166+
167+
* [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
@@ -2816,6 +2816,8 @@
28162816
href: adobe-identity-management-provisioning-oidc-tutorial.md
28172817
- name: Airstack
28182818
href: airstack-provisioning-tutorial.md
2819+
- name: Akamai Enterprise Application Access
2820+
href: akamai-enterprise-application-access-provisioning-tutorial.md
28192821
- name: AlertMedia
28202822
href: alertmedia-provisioning-tutorial.md
28212823
- name: AlexisHR

0 commit comments

Comments
 (0)