Web Apps - Update Auth Settings

Référence

Service:: App Service

API Version:: 2023-12-01

Description de Mises à jour les paramètres d’authentification/autorisation associés à l’application web.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings?api-version=2023-12-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’application web.
resourceGroupName	path	True	string	Nom du groupe de ressources auquel appartient la ressource. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 0000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Version d'API

Corps de la demande

Nom	Type	Description
kind	string	Type de ressource.
properties.aadClaimsAuthorization	string	Obtient une chaîne JSON contenant les paramètres Acl Azure AD.
properties.additionalLoginParams	string[]	Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit avoir la forme « key=value ».
properties.allowedAudiences	string[]	Valeurs d’audience autorisées à prendre en compte lors de la validation des jetons web JSON émis par Azure Active Directory. Notez que la `ClientID` valeur est toujours considérée comme un public autorisé, quel que soit ce paramètre.
properties.allowedExternalRedirectUrls	string[]	URL externes vers qui peuvent être redirigées dans le cadre de la connexion ou de la déconnexion de l’application. Notez que la partie chaîne de requête de l’URL est ignorée. Il s’agit d’un paramètre avancé généralement requis uniquement par les back-ends d’applications du Windows Store. Notez que les URL du domaine actuel sont toujours implicitement autorisées.
properties.authFilePath	string	Chemin d’accès du fichier de configuration contenant les paramètres d’authentification. Si le chemin est relatif, base sera le répertoire racine du site.
properties.clientId	string	ID client de cette application de partie de confiance, appelé client_id. Ce paramètre est requis pour activer l’authentification de connexion OpenID avec Azure Active Directory ou d’autres fournisseurs OpenID Connect tiers. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Clé secrète client de cette application de partie de confiance (dans Azure Active Directory, elle est également appelée clé). Ce paramètre est facultatif. Si aucune clé secrète client n’est configurée, le flux d’authentification implicite OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Sinon, le flux de code d’autorisation OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Une alternative à la clé secrète client, c’est-à-dire l’empreinte numérique d’un certificat utilisé à des fins de signature. Cette propriété remplace la clé secrète client. Elle est également facultative.
properties.clientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client de l’application de la partie de confiance.
properties.configVersion	string	ConfigVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement du plan de contrôle pour Authentification/Autorisation.
properties.defaultProvider	BuiltInAuthenticationProvider	Fournisseur d’authentification par défaut à utiliser lorsque plusieurs fournisseurs sont configurés. Ce paramètre n’est nécessaire que si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».
properties.enabled	boolean	`true` si la fonctionnalité Authentification/Autorisation est activée pour l’application actuelle ; sinon, `false`.
properties.facebookAppId	string	ID d’application de l’application Facebook utilisée pour la connexion. Ce paramètre est requis pour activer Facebook Connexion. documentation de connexion Facebook :https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Secret d’application de l’application Facebook utilisée pour Facebook Login. Ce paramètre est requis pour activer Facebook Connexion. documentation de connexion Facebook :https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nom du paramètre d’application qui contient le secret d’application utilisé pour Facebook Connexion.
properties.facebookOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de Facebook connexion. Ce paramètre est facultatif. documentation de connexion Facebook :https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID client de l’application GitHub utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Github
properties.gitHubClientSecret	string	Secret client de l’application GitHub utilisée pour la connexion Github. Ce paramètre est requis pour activer la connexion Github.
properties.gitHubClientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client de l’application Github utilisée pour la connexion GitHub.
properties.gitHubOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification gitHub Login. Ce paramètre est facultatif
properties.googleClientId	string	ID client OpenID Connect pour l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Clé secrète client associée à l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client associée à l’application web Google.
properties.googleOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification Google Sign-In. Ce paramètre est facultatif. S’ils ne sont pas spécifiés, « openid », « profil » et « email » sont utilisés comme étendues par défaut. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	« true » si les paramètres de configuration d’authentification doivent être lus à partir d’un fichier, « false » sinon
properties.issuer	string	URI de l’émetteur OpenID Connect qui représente l’entité qui émet des jetons d’accès pour cette application. Lorsque vous utilisez Azure Active Directory, cette valeur est l’URI du locataire d’annuaire, par exemple https://sts.windows.net/{tenant-guid}/. Cet URI est un identificateur respectant la casse pour l’émetteur du jeton. Plus d’informations sur OpenID Connect Discovery : http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Clé secrète client OAuth 2.0 qui a été créée pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nom du paramètre d’application contenant la clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification.
properties.microsoftAccountOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification du compte Microsoft. Ce paramètre est facultatif. S’il n’est pas spécifié, « wl.basic » est utilisé comme étendue par défaut. Documentation sur les étendues et autorisations de compte Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module Authentification/Autorisation.
properties.tokenRefreshExtensionHours	number	Nombre d’heures après l’expiration du jeton de session qu’un jeton de session peut être utilisé pour appeler l’API d’actualisation du jeton. La valeur par défaut est 72 heures.
properties.tokenStoreEnabled	boolean	`true` pour stocker durablement les jetons de sécurité spécifiques à la plateforme qui sont obtenus pendant les flux de connexion ; sinon, `false`. Par défaut, il s’agit de `false`.
properties.twitterConsumerKey	string	Clé de consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation twitter Sign-In : https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation twitter Sign-In : https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nom du paramètre d’application qui contient le secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.
properties.validateIssuer	boolean	Obtient une valeur indiquant si l’émetteur doit être une URL HTTPS valide et être validé en tant que telle.

Réponses

Nom	Type	Description
200 OK	SiteAuthSettings	Ok
Other Status Codes	DefaultErrorResponse	App Service réponse d’erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

Update Auth Settings

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings?api-version=2023-12-01

{
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
  "name": "authsettings",
  "type": "Microsoft.Web/sites/authsettings",
  "kind": "app",
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Définitions

Nom	Description
BuiltInAuthenticationProvider	Fournisseur d’authentification par défaut à utiliser lorsque plusieurs fournisseurs sont configurés. Ce paramètre n’est nécessaire que si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».
DefaultErrorResponse	App Service réponse d’erreur.
Details
Error	Modèle d’erreur.
SiteAuthSettings	Paramètres de configuration pour la fonctionnalité d’authentification/autorisation Azure App Service.
UnauthenticatedClientAction	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.

BuiltInAuthenticationProvider

Fournisseur d’authentification par défaut à utiliser lorsque plusieurs fournisseurs sont configurés. Ce paramètre n’est nécessaire que si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».

Nom	Type	Description
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

App Service réponse d’erreur.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

Error

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	Details[]	Erreurs détaillées.
innererror	string	Plus d’informations sur l’erreur de débogage.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

SiteAuthSettings

Paramètres de configuration pour la fonctionnalité d’authentification/autorisation Azure App Service.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.aadClaimsAuthorization	string	Obtient une chaîne JSON contenant les paramètres Acl Azure AD.
properties.additionalLoginParams	string[]	Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit avoir la forme « key=value ».
properties.allowedAudiences	string[]	Valeurs d’audience autorisées à prendre en compte lors de la validation des jetons web JSON émis par Azure Active Directory. Notez que la `ClientID` valeur est toujours considérée comme un public autorisé, quel que soit ce paramètre.
properties.allowedExternalRedirectUrls	string[]	URL externes vers qui peuvent être redirigées dans le cadre de la connexion ou de la déconnexion de l’application. Notez que la partie chaîne de requête de l’URL est ignorée. Il s’agit d’un paramètre avancé généralement requis uniquement par les back-ends d’applications du Windows Store. Notez que les URL du domaine actuel sont toujours implicitement autorisées.
properties.authFilePath	string	Chemin d’accès du fichier de configuration contenant les paramètres d’authentification. Si le chemin est relatif, base sera le répertoire racine du site.
properties.clientId	string	ID client de cette application de partie de confiance, appelé client_id. Ce paramètre est requis pour activer l’authentification de connexion OpenID avec Azure Active Directory ou d’autres fournisseurs OpenID Connect tiers. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Clé secrète client de cette application de partie de confiance (dans Azure Active Directory, elle est également appelée clé). Ce paramètre est facultatif. Si aucune clé secrète client n’est configurée, le flux d’authentification implicite OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Sinon, le flux de code d’autorisation OpenID Connect est utilisé pour authentifier les utilisateurs finaux. Plus d’informations sur OpenID Connect : http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Une alternative à la clé secrète client, c’est-à-dire l’empreinte numérique d’un certificat utilisé à des fins de signature. Cette propriété remplace la clé secrète client. Elle est également facultative.
properties.clientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client de l’application de la partie de confiance.
properties.configVersion	string	ConfigVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement du plan de contrôle pour Authentification/Autorisation.
properties.defaultProvider	BuiltInAuthenticationProvider	Fournisseur d’authentification par défaut à utiliser lorsque plusieurs fournisseurs sont configurés. Ce paramètre n’est nécessaire que si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».
properties.enabled	boolean	`true` si la fonctionnalité Authentification/Autorisation est activée pour l’application actuelle ; sinon, `false`.
properties.facebookAppId	string	ID d’application de l’application Facebook utilisée pour la connexion. Ce paramètre est requis pour activer Facebook Connexion. documentation de connexion Facebook :https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Secret d’application de l’application Facebook utilisée pour Facebook Login. Ce paramètre est requis pour activer Facebook Connexion. documentation de connexion Facebook :https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nom du paramètre d’application qui contient le secret d’application utilisé pour Facebook Connexion.
properties.facebookOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de Facebook connexion. Ce paramètre est facultatif. documentation de connexion Facebook :https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID client de l’application GitHub utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Github
properties.gitHubClientSecret	string	Secret client de l’application GitHub utilisée pour la connexion Github. Ce paramètre est requis pour activer la connexion Github.
properties.gitHubClientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client de l’application Github utilisée pour la connexion GitHub.
properties.gitHubOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification gitHub Login. Ce paramètre est facultatif
properties.googleClientId	string	ID client OpenID Connect pour l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Clé secrète client associée à l’application web Google. Ce paramètre est requis pour activer la connexion Google. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client associée à l’application web Google.
properties.googleOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification Google Sign-In. Ce paramètre est facultatif. S’ils ne sont pas spécifiés, « openid », « profil » et « email » sont utilisés comme étendues par défaut. Documentation google Sign-In : https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	« true » si les paramètres de configuration d’authentification doivent être lus à partir d’un fichier, « false » sinon
properties.issuer	string	URI de l’émetteur OpenID Connect qui représente l’entité qui émet des jetons d’accès pour cette application. Lorsque vous utilisez Azure Active Directory, cette valeur est l’URI du locataire d’annuaire, par exemple https://sts.windows.net/{tenant-guid}/. Cet URI est un identificateur respectant la casse pour l’émetteur du jeton. Plus d’informations sur OpenID Connect Discovery : http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Clé secrète client OAuth 2.0 qui a été créée pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification du compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nom du paramètre d’application contenant la clé secrète client OAuth 2.0 créée pour l’application utilisée pour l’authentification.
properties.microsoftAccountOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification du compte Microsoft. Ce paramètre est facultatif. S’il n’est pas spécifié, « wl.basic » est utilisé comme étendue par défaut. Documentation sur les étendues et autorisations de compte Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion de la fonctionnalité d’authentification/autorisation en cours d’utilisation pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module Authentification/Autorisation.
properties.tokenRefreshExtensionHours	number	Nombre d’heures après l’expiration du jeton de session qu’un jeton de session peut être utilisé pour appeler l’API d’actualisation du jeton. La valeur par défaut est 72 heures.
properties.tokenStoreEnabled	boolean	`true` pour stocker durablement les jetons de sécurité spécifiques à la plateforme qui sont obtenus pendant les flux de connexion ; sinon, `false`. Par défaut, il s’agit de `false`.
properties.twitterConsumerKey	string	Clé de consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation twitter Sign-In : https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion. Ce paramètre est requis pour activer la connexion Twitter. Documentation twitter Sign-In : https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nom du paramètre d’application qui contient le secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.
properties.validateIssuer	boolean	Obtient une valeur indiquant si l’émetteur doit être une URL HTTPS valide et être validé en tant que telle.
type	string	Type de ressource.

UnauthenticatedClientAction

Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.

Nom	Type	Description
AllowAnonymous	string
RedirectToLoginPage	string