Skip to content

Commit 43fa0e6

Browse files
authored
Merge pull request #297471 from TimShererWithAquent/us411174-07
AI Freshness Edit: Azure App Services
2 parents dd7fb47 + 848e7c2 commit 43fa0e6

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

articles/app-service/configure-authentication-provider-openid-connect.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,34 @@
22
title: Configure an OpenID Connect Provider
33
description: Learn how to configure an OpenID Connect provider as an identity provider for your App Service or Azure Functions app.
44
ms.topic: how-to
5-
ms.date: 10/20/2021
5+
ms.date: 04/02/2025
66
ms.reviewer: mahender
77
ms.custom: AppServiceIdentity
88
author: cephalin
99
ms.author: cephalin
10+
#customer intent: As an app developer, I want to use a custom authentication provider that uses the OpenID Connect specification in Azure App Service.
1011
---
1112

1213
# Configure your App Service or Azure Functions app to sign in by using an OpenID Connect provider
1314

1415
[!INCLUDE [app-service-mobile-selector-authentication](../../includes/app-service-mobile-selector-authentication.md)]
1516

16-
This article shows you how to configure Azure App Service or Azure Functions to use a custom authentication provider that adheres to the [OpenID Connect (OIDC) specification](https://openid.net/connect/). OIDC is an industry standard that many identity providers (IDPs) use. You don't need to understand the details of the specification in order to configure your app to use an adherent IDP.
17+
This article shows you how to configure Azure App Service or Azure Functions to use a custom authentication provider that adheres to the [OpenID Connect (OIDC) specification](https://openid.net/connect/). OIDC is an industry standard that many identity providers (IDPs) use. You don't need to understand the details of the specification for your app to use an OIDC identity provider.
1718

18-
You can configure your app to use one or more OIDC providers. Each must have a unique alphanumeric name in the configuration, and only one can serve as the default redirect target.
19+
You can configure your app to use one or more OIDC providers. Each provider must have a unique alphanumeric name in the configuration. Only one provider can serve as the default redirect target.
1920

2021
## <a name="register"> </a>Register your application with the identity provider
2122

2223
Your provider requires you to register the details of your application with it. One of these steps involves specifying a redirect URI that has the form `<app-url>/.auth/login/<provider-name>/callback`. Each identity provider should provide more instructions on how to complete the steps. The `<provider-name>` value refers to the friendly name that you give to the OpenID provider name in Azure.
2324

2425
> [!NOTE]
25-
> Some providers might require additional steps for their configuration and for using the values that they provide. For example, Apple provides a private key that isn't itself used as the OIDC client secret. You instead must use it to craft a JSON Web Token (JWT) that's treated as the secret that you provide in your app configuration. For more information, see [Creating a client secret](https://developer.apple.com/documentation/sign_in_with_apple/generate_and_validate_tokens) in the Apple developer documentation.
26+
> Some providers might require extra steps for their configuration and for using the values that they provide. For example, Apple provides a private key that isn't itself used as the OIDC client secret. You use it to create a JSON Web Token (JWT). You use the web token as the secret that you provide in your app configuration. For more information, see [Creating a client secret](https://developer.apple.com/documentation/sign_in_with_apple/generate_and_validate_tokens).
2627
27-
You need to collect a *client ID* and a *client secret* for your application. The client secret is an important security credential. Don't share this secret with anyone or distribute it within a client application.
28+
You need to collect a *client ID* and a *client secret* for your application. The client secret is an important security credential. Don't share this secret with anyone or distribute it in a client application.
2829

29-
Additionally, you need the OIDC metadata for the provider. This metadata is often exposed in a [configuration metadata document](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig), which is the provider's issuer URL suffixed with `/.well-known/openid-configuration`. Gather this configuration URL.
30+
You also need the OIDC metadata for the provider. This metadata is often exposed in a [configuration metadata document](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig), which is the provider's issuer URL suffixed with `/.well-known/openid-configuration`. Get this configuration URL.
3031

31-
If you can't use a configuration metadata document, gather the following values separately:
32+
If you can't use a configuration metadata document, get the following values separately:
3233

3334
- The issuer URL (sometimes shown as `issuer`)
3435
- The [OAuth 2.0 authorization endpoint](https://tools.ietf.org/html/rfc6749#section-3.1) (sometimes shown as `authorization_endpoint`)
@@ -37,26 +38,30 @@ If you can't use a configuration metadata document, gather the following values
3738

3839
## <a name="configure"> </a>Add provider information to your application
3940

41+
To add provider information for your OpenID Connect provider, follow these steps.
42+
4043
1. Sign in to the [Azure portal] and go to your app.
4144

42-
1. On the left menu, select **Authentication**. Then select **Add identity provider**.
45+
1. On the left menu, select **Settings** > **Authentication**. Then select **Add identity provider**.
4346

44-
1. In the dropdown list for identity providers, select **OpenID Connect**.
47+
1. For **Identity provider**, select **OpenID Connect**.
4548

4649
1. For **OpenID provider name**, provide the unique alphanumeric name that you selected earlier.
4750

48-
1. If you have the URL for the metadata document from the identity provider, provide that value for **Metadata URL**. Otherwise, select the **Provide endpoints separately** option and put each URL gathered from the identity provider in the appropriate field.
51+
1. If you have the URL for the metadata document from the identity provider, provide that value for **Metadata URL**.
52+
53+
Otherwise, select **Provide endpoints separately**. Put each URL from the identity provider in the appropriate field.
4954

50-
1. Provide the values that you collected earlier for **Client ID** and **Client Secret**.
55+
1. Provide the values that you collected earlier for **Client ID** and **Client secret**.
5156

52-
1. Specify an application setting name for your client secret. Your client secret is stored as an app setting to ensure that secrets are stored in a secure fashion. You can update that setting later to use [Azure Key Vault references](./app-service-key-vault-references.md) if you want to manage the secret in Key Vault.
57+
1. Specify an application setting name for your client secret. Your client secret is stored as an app setting to ensure that secrets are stored in a secure fashion. If you want to manage the secret in Azure Key vault, update that setting later to use [Azure Key Vault references](./app-service-key-vault-references.md).
5358

5459
1. Select **Add** to finish setting up the identity provider.
5560

5661
> [!NOTE]
57-
> The OpenID provider name can't contain a hyphen (-) because an app setting is created based on this name, and the app setting doesn't support hyphens. Use an underscore (_) instead.
62+
> The OpenID provider name can't contain a hyphen (-) because an app setting is created based on this name. The app setting doesn't support hyphens. Use an underscore (_) instead.
5863
>
59-
> Azure requires `openid`, `profile`, and `email` scopes. Make sure that you configured your app registration in your ID provider with at least these scopes.
64+
> Azure requires `openid`, `profile`, and `email` scopes. Make sure that you configure your app registration in your ID provider with at least these scopes.
6065
6166
## <a name="related-content"> </a>Related content
6267

0 commit comments

Comments
 (0)