Skip to content

Commit 666c692

Browse files
authored
Merge pull request #214700 from csmulligan/csm-exid-cust-attributes
[EXID] Content freshness review for custom attributes
2 parents 3ca7764 + 01755f0 commit 666c692

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed
15.3 KB
Loading
Loading
163 KB
Loading

articles/active-directory/external-identities/user-flow-add-custom-attributes.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ ms.collection: M365-identity-device-management
1818

1919
For each application, you might have different requirements for the information you want to collect during sign-up. Azure AD comes with a built-in set of information stored in attributes, such as Given Name, Surname, City, and Postal Code. With Azure AD, you can extend the set of attributes stored on a guest account when the external user signs up through a user flow.
2020

21-
You can create custom attributes in the Azure portal and use them in your self-service sign-up user flows. You can also read and write these attributes by using the [Microsoft Graph API](../../active-directory-b2c/microsoft-graph-operations.md). Microsoft Graph API supports creating and updating a user with extension attributes. Extension attributes in the Graph API are named by using the convention `extension_<extensions-app-id>_attributename`. For example:
21+
You can create custom attributes in the Azure portal and use them in your [self-service sign-up user flows](self-service-sign-up-user-flow.md). You can also read and write these attributes by using the [Microsoft Graph API](../../active-directory-b2c/microsoft-graph-operations.md). Microsoft Graph API supports creating and updating a user with extension attributes. Extension attributes in the Graph API are named by using the convention `extension_<extensions-app-id>_attributename`. For example:
2222

2323
```JSON
2424
"extension_831374b3bd5041bfaa54263ec9e050fc_loyaltyNumber": "212342"
2525
```
2626

27-
The `<extensions-app-id>` is specific to your tenant. To find this identifier, navigate to Azure Active Directory > App registrations > All applications. Search for the app that starts with "aad-extensions-app" and select it. On the app's Overview page, note the Application (client) ID.
27+
The `<extensions-app-id>` is specific to your tenant. To find this identifier, navigate to **Azure Active Directory** > **App registrations** > **All applications**. Search for the app that starts with "aad-extensions-app" and select it. On the app's Overview page, note the Application (client) ID.
2828

2929
## Create a custom attribute
3030

@@ -33,23 +33,24 @@ The `<extensions-app-id>` is specific to your tenant. To find this identifier, n
3333
3. In the left menu, select **External Identities**.
3434
4. Select **Custom user attributes**. The available user attributes are listed.
3535

36-
![Select user attributes for sign-up](media/user-flow-add-custom-attributes/user-attributes.png)
36+
:::image type="content" source="media/user-flow-add-custom-attributes/user-attributes.png" alt-text="Screenshot of selecting custom user attributes for sign-up." lightbox="media/user-flow-add-custom-attributes/user-attributes-large-image.png":::
37+
3738

3839
5. To add an attribute, select **Add**.
3940
6. In the **Add an attribute** pane, enter the following values:
4041

41-
- **Name** - Provide a name for the custom attribute (for example, "Shoesize").
42+
- **Name** - Provide a name for the custom attribute (for example, "Shoe size").
4243
- **Data Type** - Choose a data type (**String**, **Boolean**, or **Int**).
43-
- **Description** - Optionally, enter a description of the custom attribute for internal use. This description is not visible to the user.
44+
- **Description** - Optionally, enter a description of the custom attribute for internal use. This description isn't visible to the user.
4445

45-
![Add an attribute](media/user-flow-add-custom-attributes/add-an-attribute.png)
46+
:::image type="content" source="media/user-flow-add-custom-attributes/add-an-attribute.png" alt-text="Screenshot of adding a custom attribute.":::
4647

4748
7. Select **Create**.
4849

49-
The custom attribute is now available in the list of user attributes and for use in your user flows. A custom attribute is only created the first time it is used in any user flow, and not when you add it to the list of user attributes.
50+
The custom attribute is now available in the list of user attributes and for use in your user flows. A custom attribute is only created the first time it's used in any user flow, and not when you add it to the list of user attributes.
5051

51-
Once you've created a new user using a user flow that uses the newly created custom attribute, the object can be queried in [Microsoft Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). You should now see **ShoeSize** in the list of attributes collected during the sign-up journey on the user object. You can call the Graph API from your application to get the data from this attribute after it is added to the user object.
52+
Once you've created a new user using a user flow that uses the newly created custom attribute, the object can be queried in [Microsoft Graph Explorer](https://developer.microsoft.com/graph/graph-explorer). You should now see **ShoeSize** in the list of attributes collected during the sign-up journey on the user object. You can call the Graph API from your application to get the data from this attribute after it's added to the user object.
5253

5354
## Next steps
5455

55-
[Add a self-service sign-up user flow to an app](self-service-sign-up-user-flow.md)
56+
[Add a self-service sign-up user flow to an app](self-service-sign-up-user-flow.md)

0 commit comments

Comments
 (0)