Skip to content

Commit f89eea3

Browse files
Merge pull request #219630 from csmulligan/csm-exid-api-overview
[EXID] Content freshness update for api-connectors-overview (ADO-2179345)
2 parents 0bad25b + 8b5711f commit f89eea3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

articles/active-directory/external-identities/api-connectors-overview.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ services: active-directory
55
ms.service: active-directory
66
ms.subservice: B2B
77
ms.topic: conceptual
8-
ms.date: 06/16/2020
8+
ms.date: 11/28/2022
99

1010
ms.author: mimart
1111
author: msmimart
1212
manager: celestedg
1313
ms.custom: "it-pro"
14-
ms.collection: M365-identity-device-management
14+
ms.collection: engagement-fy23, M365-identity-device-management
1515
---
1616

1717
# Use API connectors to customize and extend self-service sign-up
@@ -25,7 +25,7 @@ As a developer or IT administrator, you can use [API connectors](self-service-si
2525
- **Overwrite user attributes**. Reformat or assign a value to an attribute collected from the user. For example, if a user enters the first name in all lowercase or all uppercase letters, you can format the name with only the first letter capitalized.
2626
- **Run custom business logic**. You can trigger downstream events in your cloud systems to send push notifications, update corporate databases, manage permissions, audit databases, and perform other custom actions.
2727

28-
An API connector provides Azure Active Directory with the information needed to call API endpoint by defining the HTTP endpoint URL and authentication for the API call. Once you configure an API connector, you can enable it for a specific step in a user flow. When a user reaches that step in the sign up flow, the API connector is invoked and materializes as an HTTP POST request to your API, sending user information ("claims") as key-value pairs in a JSON body. The API response can affect the execution of the user flow. For example, the API response can block a user from signing up, ask the user to re-enter information, or overwrite and append user attributes.
28+
An API connector provides Azure Active Directory with the information needed to call API endpoint by defining the HTTP endpoint URL and authentication for the API call. Once you configure an API connector, you can enable it for a specific step in a user flow. When a user reaches that step in the sign-up flow, the API connector is invoked and materializes as an HTTP POST request to your API, sending user information ("claims") as key-value pairs in a JSON body. The API response can affect the execution of the user flow. For example, the API response can block a user from signing up, ask the user to reenter information, or overwrite and append user attributes.
2929

3030
## Where you can enable an API connector in a user flow
3131

@@ -39,7 +39,7 @@ There are two places in a user flow where you can enable an API connector:
3939
4040
### After federating with an identity provider during sign-up
4141

42-
An API connector at this step in the sign-up process is invoked immediately after the user authenticates with an identity provider (like Google, Facebook, & Azure AD). This step precedes the ***attribute collection page***, which is the form presented to the user to collect user attributes. This step is not invoked if a user is registering with a local account. The following are examples of API connector scenarios you might enable at this step:
42+
An API connector at this step in the sign-up process is invoked immediately after the user authenticates with an identity provider (like Google, Facebook, & Azure AD). This step precedes the [***attribute collection page***](self-service-sign-up-user-flow.md#select-the-layout-of-the-attribute-collection-form), which is the form presented to the user to collect user attributes. This step isn't invoked if a user is registering with a local account. The following are examples of API connector scenarios you might enable at this step:
4343

4444
- Use the email or federated identity that the user provided to look up claims in an existing system. Return these claims from the existing system, pre-fill the attribute collection page, and make them available to return in the token.
4545
- Implement an allow or blocklist based on social identity.
@@ -55,4 +55,5 @@ An API connector at this step in the sign-up process is invoked after the attrib
5555

5656
## Next steps
5757
- Learn how to [add an API connector to a user flow](self-service-sign-up-add-api-connector.md)
58+
- Learn about [Azure AD entitlement management](self-service-portal.md)
5859
- Learn how to [add a custom approval system to self-service sign-up](self-service-sign-up-add-approvals.md)

0 commit comments

Comments
 (0)