Skip to content

Commit 9b7a7c4

Browse files
Merge pull request #232397 from kenwith/patch-62
Updates for clarity for acrolinx.
2 parents 6c821c8 + 6a4b226 commit 9b7a7c4

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

articles/active-directory/app-provisioning/customize-application-attributes.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.service: active-directory
88
ms.subservice: app-provisioning
99
ms.workload: identity
1010
ms.topic: tutorial
11-
ms.date: 03/27/2023
11+
ms.date: 03/28/2023
1212
ms.author: kenwith
1313
ms.reviewer: arvinh
1414
---
@@ -118,7 +118,7 @@ Applications and systems that support customization of the attribute list includ
118118

119119

120120
> [!NOTE]
121-
> Editing the list of supported attributes is only recommended for administrators who have customized the schema of their applications and systems, and have first-hand knowledge of how their custom attributes have been defined or if a source attribute isn't automatically displayed in the Azure Portal UI. This sometimes requires familiarity with the APIs and developer tools provided by an application or system. The ability to edit the list of supported attributes is locked down by default, but customers can enable the capability by navigating to the following URL: https://portal.azure.com/?Microsoft_AAD_Connect_Provisioning_forceSchemaEditorEnabled=true . You can then navigate to your application to view the attribute list as described [above](#editing-the-list-of-supported-attributes).
121+
> Editing the list of supported attributes is only recommended for administrators who have customized the schema of their applications and systems, and have first-hand knowledge of how their custom attributes have been defined or if a source attribute isn't automatically displayed in the Azure Portal UI. This sometimes requires familiarity with the APIs and developer tools provided by an application or system. The ability to edit the list of supported attributes is locked down by default, but customers can enable the capability by navigating to the following URL: https://portal.azure.com/?Microsoft_AAD_Connect_Provisioning_forceSchemaEditorEnabled=true . You can then navigate to your application to view the [attribute list](#editing-the-list-of-supported-attributes).
122122
123123
> [!NOTE]
124124
> When a directory extension attribute in Azure AD doesn't show up automatically in your attribute mapping drop-down, you can manually add it to the "Azure AD attribute list". When manually adding Azure AD directory extension attributes to your provisioning app, note that directory extension attribute names are case-sensitive. For example: If you have a directory extension attribute named `extension_53c9e2c0exxxxxxxxxxxxxxxx_acmeCostCenter`, make sure you enter it in the same format as defined in the directory.
@@ -138,7 +138,7 @@ When you're editing the list of supported attributes, the following properties a
138138
- **Multi-value?** - Whether the attribute supports multiple values.
139139
- **Exact case?** - Whether the attributes values are evaluated in a case-sensitive way.
140140
- **API Expression** - Don't use, unless instructed to do so by the documentation for a specific provisioning connector (such as Workday).
141-
- **Referenced Object Attribute** - If it's a Reference type attribute, then this menu lets you select the table and attribute in the target application that contains the value associated with the attribute. For example, if you have an attribute named "Department" whose stored value references an object in a separate "Departments" table, you would select "Departments.Name". The reference tables and the primary ID fields supported for a given application are preconfigured and currently can't be edited using the Azure portal, but can be edited using the [Microsoft Graph API](/graph/api/resources/synchronization-configure-with-custom-target-attributes).
141+
- **Referenced Object Attribute** - If it's a Reference type attribute, then this menu lets you select the table and attribute in the target application that contains the value associated with the attribute. For example, if you have an attribute named "Department" whose stored value references an object in a separate "Departments" table, you would select "Departments.Name". The reference tables and the primary ID fields supported for a given application are preconfigured and can't be edited using the Azure portal. However, you can edit them using the [Microsoft Graph API](/graph/api/resources/synchronization-configure-with-custom-target-attributes).
142142

143143
#### Provisioning a custom extension attribute to a SCIM compliant application
144144
The SCIM RFC defines a core user and group schema, while also allowing for extensions to the schema to meet your application's needs. To add a custom attribute to a SCIM application:
@@ -152,7 +152,7 @@ For SCIM applications, the attribute name must follow the pattern shown in the e
152152

153153
These instructions are only applicable to SCIM-enabled applications. Applications such as ServiceNow and Salesforce aren't integrated with Azure AD using SCIM, and therefore they don't require this specific namespace when adding a custom attribute.
154154

155-
Custom attributes can't be referential attributes, multi-value or complex-typed attributes. Custom multi-value and complex-typed extension attributes are currently supported only for applications in the gallery. The custom extension schema header is omitted in the example because it isn't sent in requests from the Azure AD SCIM client. This issue will be fixed in the future and the header will be sent in the request.
155+
Custom attributes can't be referential attributes, multi-value or complex-typed attributes. Custom multi-value and complex-typed extension attributes are currently supported only for applications in the gallery. The custom extension schema header is omitted in the example because it isn't sent in requests from the Azure AD SCIM client.
156156

157157
**Example representation of a user with an extension attribute:**
158158

@@ -196,17 +196,17 @@ Custom attributes can't be referential attributes, multi-value or complex-typed
196196

197197

198198
## Provisioning a role to a SCIM app
199-
Use the steps in the example to provision roles for a user to your application. Note that the description is specific to custom SCIM applications. For gallery applications such as Salesforce and ServiceNow, use the predefined role mappings. The bullets describe how to transform the AppRoleAssignments attribute to the format your application expects.
199+
Use the steps in the example to provision roles for a user to your application. The description is specific to custom SCIM applications. For gallery applications such as Salesforce and ServiceNow, use the predefined role mappings. The bullets describe how to transform the AppRoleAssignments attribute to the format your application expects.
200200

201201
- Mapping an appRoleAssignment in Azure AD to a role in your application requires that you transform the attribute using an [expression](../app-provisioning/functions-for-customizing-application-data.md). The appRoleAssignment attribute **shouldn't be mapped directly** to a role attribute without using an expression to parse the role details.
202202

203203
- **SingleAppRoleAssignment**
204204
- **When to use:** Use the SingleAppRoleAssignment expression to provision a single role for a user and to specify the primary role.
205-
- **How to configure:** Use the steps described above to navigate to the attribute mappings page and use the SingleAppRoleAssignment expression to map to the roles attribute. There are three role attributes to choose from (`roles[primary eq "True"].display`, `roles[primary eq "True"].type`, and `roles[primary eq "True"].value`). You can choose to include any or all of the role attributes in your mappings. If you would like to include more than one, just add a new mapping and include it as the target attribute.
205+
- **How to configure:** Use the steps described to navigate to the attribute mappings page and use the SingleAppRoleAssignment expression to map to the roles attribute. There are three role attributes to choose from (`roles[primary eq "True"].display`, `roles[primary eq "True"].type`, and `roles[primary eq "True"].value`). You can choose to include any or all of the role attributes in your mappings. If you would like to include more than one, just add a new mapping and include it as the target attribute.
206206

207207
![Add SingleAppRoleAssignment](./media/customize-application-attributes/edit-attribute-singleapproleassignment.png)
208208
- **Things to consider**
209-
- Ensure that multiple roles aren't assigned to a user. We can't guarantee which role will be provisioned.
209+
- Ensure that multiple roles aren't assigned to a user. There is no guarantee which role is provisioned.
210210
- SingleAppRoleAssignments isn't compatible with setting scope to "Sync All users and groups."
211211
- **Example request (POST)**
212212

@@ -249,15 +249,15 @@ The request formats in the PATCH and POST differ. To ensure that POST and PATCH
249249

250250
- **AppRoleAssignmentsComplex**
251251
- **When to use:** Use the AppRoleAssignmentsComplex expression to provision multiple roles for a user.
252-
- **How to configure:** Edit the list of supported attributes as described above to include a new attribute for roles:
252+
- **How to configure:** Edit the list of supported attributes as described to include a new attribute for roles:
253253

254254
![Add roles](./media/customize-application-attributes/add-roles.png)<br>
255255

256256
Then use the AppRoleAssignmentsComplex expression to map to the custom role attribute as shown in the image:
257257

258258
![Add AppRoleAssignmentsComplex](./media/customize-application-attributes/edit-attribute-approleassignmentscomplex.png)<br>
259259
- **Things to consider**
260-
- All roles will be provisioned as primary = false.
260+
- All roles are provisioned as primary = false.
261261
- The POST contains the role type. The PATCH request doesn't contain type. We're working on sending the type in both POST and PATCH requests.
262262
- AppRoleAssignmentsComplex isn't compatible with setting scope to "Sync All users and groups."
263263

0 commit comments

Comments
 (0)