Skip to content

Commit 6f0a0f5

Browse files
prmerger-automator[bot]prmerger-automator[bot]
authored
Merge pull request #279668 from craigshoemaker/patch-10
[Static Web Apps] Update: Authentication custom -> clarify location of client secret
2 parents e25993f + 4a1cbea commit 6f0a0f5

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

‎articles/static-web-apps/authentication-custom.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: aaronpowell
66
ms.author: aapowell
77
ms.service: static-web-apps
88
ms.topic: conceptual
9-
ms.date: 01/10/2024
9+
ms.date: 06/28/2024
1010
---
1111

1212
# Custom authentication in Azure Static Web Apps
@@ -33,7 +33,7 @@ To create the registration, begin by creating the following [application setting
3333
| Setting Name | Value |
3434
| --- | --- |
3535
| `AZURE_CLIENT_ID` | The Application (client) ID for the Microsoft Entra app registration. |
36-
| `AZURE_CLIENT_SECRET` | The client secret for the Microsoft Entra app registration. |
36+
| `AZURE_CLIENT_SECRET_APP_SETTING_NAME | The name of the application setting that holds the client secret for the Microsoft Entra app registration. |
3737

3838
Next, use the following sample to configure the provider in the [configuration file](configuration.md).
3939

@@ -52,7 +52,7 @@ Microsoft Entra providers are available in two different versions. Version 1 exp
5252
"registration": {
5353
"openIdIssuer": "https://login.microsoftonline.com/<TENANT_ID>",
5454
"clientIdSettingName": "AZURE_CLIENT_ID",
55-
"clientSecretSettingName": "AZURE_CLIENT_SECRET"
55+
"clientSecretSettingName": "AZURE_CLIENT_SECRET_APP_SETTING_NAME"
5656
}
5757
}
5858
}
@@ -74,7 +74,7 @@ Make sure to replace `<TENANT_ID>` with your Microsoft Entra tenant ID.
7474
"registration": {
7575
"openIdIssuer": "https://login.microsoftonline.com/<TENANT_ID>/v2.0",
7676
"clientIdSettingName": "AZURE_CLIENT_ID",
77-
"clientSecretSettingName": "AZURE_CLIENT_SECRET"
77+
"clientSecretSettingName": "AZURE_CLIENT_SECRET_APP_SETTING_NAME"
7878
}
7979
}
8080
}
@@ -142,7 +142,7 @@ To create the registration, begin by creating the following [application setting
142142
| Setting Name | Value |
143143
| --- | --- |
144144
| `APPLE_CLIENT_ID` | The Apple client ID. |
145-
| `APPLE_CLIENT_SECRET` | The Apple client secret. |
145+
| `APPLE_CLIENT_SECRET_APP_SETTING_NAME` | The name of the application setting that holds the Apple client secret. |
146146

147147
Next, use the following sample to configure the provider in the [configuration file](configuration.md).
148148

@@ -153,7 +153,7 @@ Next, use the following sample to configure the provider in the [configuration f
153153
"apple": {
154154
"registration": {
155155
"clientIdSettingName": "APPLE_CLIENT_ID",
156-
"clientSecretSettingName": "APPLE_CLIENT_SECRET"
156+
"clientSecretSettingName": "APPLE_CLIENT_SECRET_APP_SETTING_NAME"
157157
}
158158
}
159159
}
@@ -170,7 +170,7 @@ To create the registration, begin by creating the following [application setting
170170
| Setting Name | Value |
171171
| --- | --- |
172172
| `FACEBOOK_APP_ID` | The Facebook application ID. |
173-
| `FACEBOOK_APP_SECRET` | The Facebook application secret. |
173+
| `FACEBOOK_APP_SECRET_APP_SETTING_NAME` | The name of the application setting that holds the Facebook application secret. |
174174

175175
Next, use the following sample to configure the provider in the [configuration file](configuration.md).
176176

@@ -181,7 +181,7 @@ Next, use the following sample to configure the provider in the [configuration f
181181
"facebook": {
182182
"registration": {
183183
"appIdSettingName": "FACEBOOK_APP_ID",
184-
"appSecretSettingName": "FACEBOOK_APP_SECRET"
184+
"appSecretSettingName": "FACEBOOK_APP_SECRET_APP_SETTING_NAME"
185185
}
186186
}
187187
}
@@ -199,7 +199,7 @@ To create the registration, begin by creating the following [application setting
199199
| Setting Name | Value |
200200
| --- | --- |
201201
| `GITHUB_CLIENT_ID` | The GitHub client ID. |
202-
| `GITHUB_CLIENT_SECRET` | The GitHub client secret. |
202+
| `GITHUB_CLIENT_SECRET_APP_SETTING_NAME` | The name of the application setting that holds the GitHub client secret. |
203203

204204
Next, use the following sample to configure the provider in the [configuration file](configuration.md).
205205

@@ -210,7 +210,7 @@ Next, use the following sample to configure the provider in the [configuration f
210210
"github": {
211211
"registration": {
212212
"clientIdSettingName": "GITHUB_CLIENT_ID",
213-
"clientSecretSettingName": "GITHUB_CLIENT_SECRET"
213+
"clientSecretSettingName": "GITHUB_CLIENT_SECRET_APP_SETTING_NAME"
214214
}
215215
}
216216
}
@@ -226,7 +226,7 @@ To create the registration, begin by creating the following [application setting
226226
| Setting Name | Value |
227227
| --- | --- |
228228
| `GOOGLE_CLIENT_ID` | The Google client ID. |
229-
| `GOOGLE_CLIENT_SECRET` | The Google client secret. |
229+
| `GOOGLE_CLIENT_SECRET_APP_SETTING_NAME` | The name of the application setting that holds the Google client secret. |
230230

231231
Next, use the following sample to configure the provider in the [configuration file](configuration.md).
232232

@@ -237,7 +237,7 @@ Next, use the following sample to configure the provider in the [configuration f
237237
"google": {
238238
"registration": {
239239
"clientIdSettingName": "GOOGLE_CLIENT_ID",
240-
"clientSecretSettingName": "GOOGLE_CLIENT_SECRET"
240+
"clientSecretSettingName": "GOOGLE_CLIENT_SECRET_APP_SETTING_NAME"
241241
}
242242
}
243243
}
@@ -247,14 +247,14 @@ Next, use the following sample to configure the provider in the [configuration f
247247

248248
For more information on how to configure Google as an authentication provider, see the [App Service Authentication/Authorization documentation](../app-service/configure-authentication-provider-google.md).
249249

250-
# [Twitter](#tab/twitter)
250+
# [X (Twitter)](#tab/twitter)
251251

252252
To create the registration, begin by creating the following [application settings](application-settings.yml):
253253

254254
| Setting Name | Value |
255255
| --- | --- |
256-
| `TWITTER_CONSUMER_KEY` | The Twitter consumer key. |
257-
| `TWITTER_CONSUMER_SECRET` | The Twitter consumer secret. |
256+
| `X_CONSUMER_KEY` | The X (Twitter) consumer key. |
257+
| `X_CONSUMER_SECRET_APP_SETTING_NAME` | The name of the application setting that holds the X (Twitter) consumer secret. |
258258

259259
Next, use the following sample to configure the provider in the [configuration file](configuration.md).
260260

@@ -264,8 +264,8 @@ Next, use the following sample to configure the provider in the [configuration f
264264
"identityProviders": {
265265
"twitter": {
266266
"registration": {
267-
"consumerKeySettingName": "TWITTER_CONSUMER_KEY",
268-
"consumerSecretSettingName": "TWITTER_CONSUMER_SECRET"
267+
"consumerKeySettingName": "X_CONSUMER_KEY",
268+
"consumerSecretSettingName": "X_CONSUMER_SECRET_APP_SETTING_NAME"
269269
}
270270
}
271271
}
@@ -292,7 +292,7 @@ Once the application is registered with the identity provider, create the follow
292292
| Setting Name | Value |
293293
| --- | --- |
294294
| `MY_PROVIDER_CLIENT_ID` | The client ID generated by the authentication provider for your static web app. |
295-
| `MY_PROVIDER_CLIENT_SECRET` | The client secret generated by the authentication provider's custom registration for your static web app. |
295+
| `MY_PROVIDER_CLIENT_SECRET_APP_SETTING_NAME` | The name of the application setting that holds the client secret generated by the authentication provider's custom registration for your static web app. |
296296

297297
If you register other providers, each one needs an associated client ID and client secret store in application settings.
298298

@@ -314,7 +314,7 @@ Once you have the registration credentials, use the following steps to create a
314314
"registration": {
315315
"clientIdSettingName": "MY_PROVIDER_CLIENT_ID",
316316
"clientCredential": {
317-
"clientSecretSettingName": "MY_PROVIDER_CLIENT_SECRET"
317+
"clientSecretSettingName": "MY_PROVIDER_CLIENT_SECRET_APP_SETTING_NAME"
318318
},
319319
"openIdConnectConfiguration": {
320320
"wellKnownOpenIdConfiguration": "https://<PROVIDER_ISSUER_URL>/.well-known/openid-configuration"

0 commit comments

Comments
 (0)