You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/develop/custom-claims-provider-overview.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ ms.custom: aaddev
17
17
#Customer intent: As a developer, I want to learn about custom claims provider so that I can augment tokens with claims from an external identity system or role management system.
18
18
---
19
19
20
-
# Custom claims provider
20
+
# Custom claims provider (preview)
21
21
22
-
This article provides an overview to the custom claims provider, as part of [custom authentication extensions](./custom-extension-overview.md).
22
+
This article provides an overview to the Azure Active Directory (Azure AD) custom claims provider.
23
23
When a user authenticates to an application, a custom claims provider can be used to add claims into the token. A custom claims provider is made up of a custom extension that calls an external REST API, to fetch claims from external systems. A custom claims provider can be assigned to one or many applications in your directory.
24
24
25
25
Key data about a user is often stored in systems external to Azure AD. For example, secondary email, billing tier, or sensitive information. Some applications may rely on these attributes for the application to function as designed. For example, the application may block access to certain features based on a claim in the token.
@@ -31,9 +31,9 @@ Use a custom claims provider for the following scenarios:
31
31
32
32
## Token issuance start event listener
33
33
34
-
A custom claims provider allows mapping claims from an external source into the token when the user signs into an application. It uses a custom extension to fetch attributes from an external REST API. The custom extension uses the **token issuance start** event listener, which causes it to be triggered when a token is about to be issued by Azure AD. The trigger event is configured within the custom extension, by using the **token issuance start** event type.
34
+
An event listener is a procedure that waits for an event to occur. The custom extension uses the **token issuance start** event listener. The event is triggered when a token is about to be issued to your application. When the event is triggered the custom extension REST API is called to fetch attributes from external systems.
35
35
36
-
For an example using a custom claims provider with the **token issuance start**, check out the [get started with custom claims providers](custom-extension-get-started.md) article.
36
+
For an example using a custom claims provider with the **token issuance start** event listener, check out the [get started with custom claims providers](custom-extension-get-started.md) article.
Copy file name to clipboardExpand all lines: articles/active-directory/develop/custom-extension-get-started.md
+86-86Lines changed: 86 additions & 86 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Get started with custom claims providers (preview)
3
3
titleSuffix: Microsoft identity platform
4
-
description: Use a custom authentication extension to augment tokens with claims from an external identity system. Learn how to create and deploy a custom authentication extension REST API. The REST API receives HTTP requests, or events, from the Azure AD event service and return attributes from an external data store. Learn how to register the custom authentication extensions so the Azure AD event service sends an HTTP request, or event, to your custom authentication extensionsAPI endpoint.
4
+
description: Learn how to develop and register an Azure Active Directory custom extensions REST API. The custom extension allows you to source claims from a data store that is external to Azure Active Directory.
5
5
services: active-directory
6
6
author: yoelhor
7
7
manager: CelesteDG
@@ -19,7 +19,7 @@ ms.reviewer: JasSuri
19
19
20
20
# Configure a custom claim provider token issuance event (preview)
21
21
22
-
This article describes how to configure and setup a custom authentication extension with the [token issuance start event](custom-claims-provider-overview.md#token-issuance-start-event-listener) type. This event is triggered right before the token is issued, and allows you to call a REST API to add claims to the token.
22
+
This article describes how to configure and setup a custom claims provider with the [token issuance start event](custom-claims-provider-overview.md#token-issuance-start-event-listener) type. This event is triggered right before the token is issued, and allows you to call a REST API to add claims to the token.
23
23
24
24
This how-to guide demonstrates the token issuance start event with a REST API running in Azure Functions and a sample OpenID Connect application.
25
25
@@ -194,11 +194,11 @@ Create an Application Registration to authenticate your custom extension to your
Anexamplevaluewouldbe `api://authenticationeventsAPI.azurewebsites.net/f4a70782-3191-45b4-b7e5-dd415885dd80`. Take note of this value as it is used in following steps and is referenced as `{functionApp_IdentifierUri}`.
Anexamplevaluewouldbe `api://authenticationeventsAPI.azurewebsites.net/f4a70782-3191-45b4-b7e5-dd415885dd80`. Take note of this value as it is used in following steps and is referenced as `{functionApp_IdentifierUri}`.
:::imagetype="content"border="false"source="media/custom-extension-get-started/configure-auth-function-app.png"alt-text="Screenshot that shows how to add authentication to your function app."lightbox="media/custom-extension-get-started/configure-auth-function-app.png":::
500
+
:::imagetype="content"border="true"source="media/custom-extension-get-started/configure-auth-function-app.png"alt-text="Screenshot that shows how to add authentication to your function app."lightbox="media/custom-extension-get-started/configure-auth-function-app.png":::
Copy file name to clipboardExpand all lines: articles/active-directory/develop/custom-extension-overview.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Custom authentication extension
3
3
titleSuffix: Microsoft identity platform
4
-
description: Use a custom authentication extension to augment tokens with claims from an external identity system or role management system. Custom authentication extensions can be used to migrate from AD FS or legacy systems. You can also integrate with data stores external to your Azure AD directory or keep sensitive information stored outside of your Azure AD directory.
4
+
description: Use Azure Active Directory custom extensions to customize your user's sign-in experience by using REST APIs or outbound webhooks.
5
5
services: active-directory
6
6
author: yoelhor
7
7
manager: CelesteDG
@@ -33,8 +33,6 @@ The following diagram depicts the sign-in flow integrated with a custom extensio
33
33
1. The Azure AD **custom extension** processes the response and customizes the authentication based on the event type and the HTTP response payload.
34
34
1. A **token** is returned to the **app**.
35
35
36
-
Depending on the custom extension, it could be integrated in different authentication journeys, for example self-service sign-up.
37
-
38
36
## Custom extension REST API endpoint
39
37
40
38
When an event fires, Azure AD calls a REST API endpoint you own. The request to the REST API contains information about the event, the user profile, authentication request data, and other context information.
Copy file name to clipboardExpand all lines: articles/active-directory/develop/custom-extension-troubleshoot.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,7 +175,7 @@ To test your API directly from the Postman, follow these steps:
175
175
One of the most common issues is that your custom claims provider API doesn't respond within the two-seconds timeout. If your REST API doesn't respond in subsequent retries, then the authentication fails. To improve the performance of your REST API, follow the below suggestions:
176
176
177
177
1. If your API accesses any downstream APIs, cache the access token used to call these APIs, so a new token doesn't have to be acquired on every execution.
178
-
1. Performance issues are often been in a downstream service. Add logging, which records the process time to call to any downstream services.
178
+
1. Performance issues are often related to downstream services. Add logging, which records the process time to call to any downstream services.
179
179
1. If you use a cloud provider to host your API, use a hosting plan that keeps the API always "warm". For Azure Functions, it can be either [the Premium plan or Dedicated plan](../../azure-functions/functions-scale.md).
180
180
1. [Run automated integration tests](test-automate-integration-testing.md) for your authentications. You can also use Postman or other tools to test just your API performance.
0 commit comments