Skip to content

Commit 2a4d0da

Browse files
authored
custom authentication extension > custom extension
1 parent 4038859 commit 2a4d0da

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

articles/active-directory/develop/custom-extension-get-started.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Get started with custom claims providers (preview)
33
titleSuffix: Microsoft identity platform
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.
4+
description: Learn how to develop and register an Azure Active Directory custom authentication extensions REST API. The custom authentication extension allows you to source claims from a data store that is external to Azure Active Directory.
55
services: active-directory
66
author: yoelhor
77
manager: CelesteDG
@@ -58,7 +58,7 @@ In this step, you create an HTTP trigger function API in the Azure portal. The f
5858

5959
### 1.1 Create an HTTP trigger function
6060

61-
After the Azure Function app is created, create an HTTP trigger function. The HTTP trigger lets you invoke a function with an HTTP request. This HTTP trigger will be referenced and called by your Azure AD custom extension.
61+
After the Azure Function app is created, create an HTTP trigger function. The HTTP trigger lets you invoke a function with an HTTP request. This HTTP trigger will be referenced and called by your Azure AD custom authentication extension.
6262

6363
1. Within your **Function App**, from the menu select **Functions**.
6464
1. From the top menu, select **+ Create**.
@@ -151,9 +151,9 @@ The following screenshot demonstrates how to configure the Azure HTTP trigger fu
151151

152152
1. From the top menu, select **Get Function Url**, and copy the URL. In the next step, the function URL will be used and referred to as `{Function_Url}`.
153153

154-
## Step 2. Register a custom extension
154+
## Step 2. Register a custom authentication extension
155155

156-
In this step, you configure a custom extension, which will be used by Azure AD to call your Azure function. The custom extension contains information about your REST API endpoint, the claims that it parses from your REST API, and how to authenticate to your REST API. Follow these steps to register a custom extension:
156+
In this step, you configure a custom authentication extension, which will be used by Azure AD to call your Azure function. The custom authentication extension contains information about your REST API endpoint, the claims that it parses from your REST API, and how to authenticate to your REST API. Follow these steps to register a custom authentication extension:
157157

158158
# [Azure portal](#tab/azure-portal)
159159

@@ -162,13 +162,13 @@ In this step, you configure a custom extension, which will be used by Azure AD t
162162
1. Ensure your user account has the Global Administrator or Application Administrator and Authentication Extensibility Administrator role. Otherwise, learn how to [assign a role](../roles/manage-roles-portal.md).
163163
1. From the menu, select **Enterprise applications**.
164164
1. Under **Manage**, select the **Custom authentication extensions**.
165-
1. Select **Create a custom extension**.
165+
1. Select **Create a custom authentication extension**.
166166
1. In **Basics**, select the **tokenIssuanceStart** event and select **Next**.
167167
1. In **Endpoint Configuration**, fill in the following properties:
168168

169-
- **Name** - A name for your custom extension. For example, *Token issuance event*.
169+
- **Name** - A name for your custom authentication extension. For example, *Token issuance event*.
170170
- **Target Url** - The `{Function_Url}` of your Azure Function URL.
171-
- **Description** - A description for your custom extensions.
171+
- **Description** - A description for your custom authentication extensions.
172172

173173
1. Select **Next**.
174174

@@ -178,20 +178,20 @@ In this step, you configure a custom extension, which will be used by Azure AD t
178178

179179
1. Select **Next**.
180180

181-
1. In **Claims**, enter the attributes that you expect your custom extension to parse from your REST API and will be merged into the token. Add the following claims:
181+
1. In **Claims**, enter the attributes that you expect your custom authentication extension to parse from your REST API and will be merged into the token. Add the following claims:
182182

183183
- dateOfBirth
184184
- customRoles
185185
- apiVersion
186186
- correlationId
187187

188-
1. Select **Next** and **Create**, which registers the custom extension and the associated application registration.
188+
1. Select **Next** and **Create**, which registers the custom authentication extension and the associated application registration.
189189

190190
# [Microsoft Graph](#tab/microsoft-graph)
191191

192-
Create an Application Registration to authenticate your custom extension to your Azure Function.
192+
Create an Application Registration to authenticate your custom authentication extension to your Azure Function.
193193

194-
1. Sign in to the [Microsoft Graph Explorer](https://aka.ms/ge) using an account whose home tenant is the tenant you wish to manage your custom extension in.
194+
1. Sign in to the [Microsoft Graph Explorer](https://aka.ms/ge) using an account whose home tenant is the tenant you wish to manage your custom authentication extension in.
195195
1. Set the HTTP method to **POST**.
196196
1. Paste the URL: `https://graph.microsoft.com/v1.0/applications`
197197
1. Select **Request Body** and paste the following JSON:
@@ -262,9 +262,9 @@ Update the newly created application to set the application ID URI value, the ac
262262

263263
1. Select **Run Query** to submit the request.
264264

265-
### Register a custom extension
265+
### Register a custom authentication extension
266266

267-
Next, you register the custom extension. You register the custom extension by associating it with the App Registration for the Azure Function, and your Azure Function endpoint `{Function_Url}`.
267+
Next, you register the custom authentication extension. You register the custom authentication extension by associating it with the App Registration for the Azure Function, and your Azure Function endpoint `{Function_Url}`.
268268

269269
1. Set the HTTP method to **POST**.
270270
1. Paste the URL: `https://graph.microsoft.com/beta/identity/customAuthenticationExtensions`
@@ -304,17 +304,17 @@ Record the ID value of the created custom claims provider object. The ID is need
304304

305305
### 2.2 Grant admin consent
306306

307-
After your custom extension is created, you'll be taken to the **Overview** tab of the new custom extension.
307+
After your custom authentication extension is created, you'll be taken to the **Overview** tab of the new custom authentication extension.
308308

309-
From the **Overview** page, select the **Grant permission** button to give admin consent to the registered app, which allows the custom extension to authenticate to your API. The custom extension uses `client_credentials` to authenticate to the Azure Function App using the `Receive custom authentication extension HTTP requests` permission.
309+
From the **Overview** page, select the **Grant permission** button to give admin consent to the registered app, which allows the custom authentication extension to authenticate to your API. The custom authentication extension uses `client_credentials` to authenticate to the Azure Function App using the `Receive custom authentication extension HTTP requests` permission.
310310

311311
The following screenshot shows how to grant permissions.
312312

313313
:::image type="content" border="false"source="./media/custom-extension-get-started/custom-extensions-overview.png" alt-text="Screenshot that shows how grant admin consent." lightbox="media/custom-extension-get-started/custom-extensions-overview.png":::
314314

315315
## Step 3. Configure an OpenID Connect app to receive enriched tokens
316316

317-
To get a token and test the custom extension, you can use the <https://jwt.ms> app. It's a Microsoft-owned web application that displays the decoded contents of a token (the contents of the token never leave your browser).
317+
To get a token and test the custom authentication extension, you can use the <https://jwt.ms> app. It's a Microsoft-owned web application that displays the decoded contents of a token (the contents of the token never leave your browser).
318318
319319
Follow these steps to register the **jwt.ms** web application:
320320

@@ -347,7 +347,7 @@ The **jwt.ms** test application uses the implicit flow. Enable implicit flow in
347347

348348
### 3.3 Enable your App for a claims mapping policy
349349

350-
A claims mapping policy is used to select which attributes returned from the custom extension are mapped into the token. To allow tokens to be augmented, you must explicitly enable the application registration to accept mapped claims:
350+
A claims mapping policy is used to select which attributes returned from the custom authentication extension are mapped into the token. To allow tokens to be augmented, you must explicitly enable the application registration to accept mapped claims:
351351

352352
1. In your *My Test application* registration, under **Manage**, select **Manifest**.
353353
1. In the manifest, locate the `acceptMappedClaims` attribute, and set the value to `true`.
@@ -369,13 +369,13 @@ The following JSON snippet demonstrates how to configure these properties.
369369

370370
## Step 4. Assign a custom claims provider to your app
371371

372-
For tokens to be issued with claims incoming from the custom extension, you must assign a custom claims provider to your application. The custom claims provider relies on the custom extension configured with the **token issuance start** event listener. You can choose whether all, or a subset of claims, from the custom claims provider are mapped into the token.
372+
For tokens to be issued with claims incoming from the custom authentication extension, you must assign a custom claims provider to your application. The custom claims provider relies on the custom authentication extension configured with the **token issuance start** event listener. You can choose whether all, or a subset of claims, from the custom claims provider are mapped into the token.
373373

374-
Follow these steps to connect the *My Test application* with your custom extension:
374+
Follow these steps to connect the *My Test application* with your custom authentication extension:
375375

376376
# [Azure portal](#tab/azure-portal)
377377

378-
First assign the custom extension as a custom claims provider source:
378+
First assign the custom authentication extension as a custom claims provider source:
379379

380380
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to **Azure Active Directory**.
381381
1. Select **App registrations**, and find the *My Test application* registration you created.
@@ -402,14 +402,14 @@ Next, assign the attributes from the custom claims provider, which should be iss
402402

403403
# [Microsoft Graph](#tab/microsoft-graph)
404404

405-
First create an event listener to trigger a custom extension using the token issuance start event:
405+
First create an event listener to trigger a custom authentication extension using the token issuance start event:
406406

407-
1. Sign in to the [Microsoft Graph Explorer](https://aka.ms/ge) using an account whose home tenant is the tenant you wish to manage your custom extension in.
407+
1. Sign in to the [Microsoft Graph Explorer](https://aka.ms/ge) using an account whose home tenant is the tenant you wish to manage your custom authentication extension in.
408408
1. Set the HTTP method to **POST**.
409409
1. Paste the URL: `https://graph.microsoft.com/beta/identity/authenticationEventListeners`
410410
1. Select **Request Body** and paste the following JSON:
411411

412-
Replace `{App_to_enrich_ID}` with the app ID of *My Test application* recorded earlier. Replace `{customExtensionObjectId}` with the custom extension ID recorded earlier.
412+
Replace `{App_to_enrich_ID}` with the app ID of *My Test application* recorded earlier. Replace `{customExtensionObjectId}` with the custom authentication extension ID recorded earlier.
413413

414414
```json
415415
{
@@ -479,12 +479,12 @@ Assign the claims mapping policy to the `servicePrincipal` of *My Test Applicati
479479

480480
## Step 5. Protect your Azure Function
481481

482-
Azure AD custom extension uses server to server flow to obtain an access token that is sent in the HTTP `Authorization` header to your Azure function. When publishing your function to Azure, especially in a production environment, you need to validate the token sent in the authorization header.
482+
Azure AD custom authentication extension uses server to server flow to obtain an access token that is sent in the HTTP `Authorization` header to your Azure function. When publishing your function to Azure, especially in a production environment, you need to validate the token sent in the authorization header.
483483

484484
To protect your Azure function, follow these steps to integrate Azure AD authentication, for validating incoming tokens with your *Azure Functions authentication events API* application registration.
485485

486486
> [!NOTE]
487-
> If the Azure function app is hosted in a different Azure tenant than the tenant in which your custom extension is registered, skip to [using OpenID Connect identity provider](#51-using-openid-connect-identity-provider) step.
487+
> If the Azure function app is hosted in a different Azure tenant than the tenant in which your custom authentication extension is registered, skip to [using OpenID Connect identity provider](#51-using-openid-connect-identity-provider) step.
488488

489489
1. In the [Azure portal](https://portal.azure.com), navigate and select the function app you previously published.
490490
1. Select **Authentication** in the menu on the left.
@@ -499,7 +499,7 @@ To protect your Azure function, follow these steps to integrate Azure AD authent
499499

500500
### 5.1 Using OpenID Connect identity provider
501501

502-
If you configured the [Microsoft identity provider](#step-5-protect-your-azure-function), skip this step. Otherwise, if the Azure Function is hosted under a different tenant than the tenant in which your custom extension is registered, follow these steps to protect your function:
502+
If you configured the [Microsoft identity provider](#step-5-protect-your-azure-function), skip this step. Otherwise, if the Azure Function is hosted under a different tenant than the tenant in which your custom authentication extension is registered, follow these steps to protect your function:
503503

504504
1. In the [Azure portal](https://portal.azure.com), navigate and select the function app you previously published.
505505
1. Select **Authentication** in the menu on the left.
@@ -514,7 +514,7 @@ If you configured the [Microsoft identity provider](#step-5-protect-your-azure-f
514514

515515
1. Under the **App registration**, enter the application ID (client ID) of the *Azure Functions authentication events API* app registration [you created previously](#step-2-register-a-custom-extension).
516516

517-
1. Go to your Azure AD tenant in which your custom extension is registered, and select **Azure Active Directory** > **App registrations**.
517+
1. Go to your Azure AD tenant in which your custom authentication extension is registered, and select **Azure Active Directory** > **App registrations**.
518518
1. Select the *Azure Functions authentication events API* app registration [you created previously](#step-2-register-a-custom-extension).
519519
1. Select **Certificates & secrets** > **Client secrets** > **New client secret**.
520520
1. Add a description for your client secret.
@@ -545,4 +545,4 @@ To test your custom claim provider, follow these steps:
545545

546546
- Learn more about custom claims providers with the [custom claims provider reference](custom-claims-provider-reference.md) article.
547547

548-
- Learn how to [troubleshoot your custom extensions API](custom-extension-troubleshoot.md).
548+
- Learn how to [troubleshoot your custom authentication extensions API](custom-extension-troubleshoot.md).

0 commit comments

Comments
 (0)