Web Apps - Get Auth Settings V2

Service:

App Service

Version d'API:

2024-04-01

Description des paramètres d’authentification/d’autorisation du site pour les applications via le format V2

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list?api-version=2024-04-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
name	path	True	string	Nom de l’application.
resourceGroupName	path	True	string	Nom du groupe de ressources auquel appartient la ressource. Modèle d’expression régulière: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	VOTRE ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000000-0000-0000-0000-00000000000000000000000).
api-version	query	True	string	Version de l’API

Réponses

Nom	Type	Description
200 OK	SiteAuthSettingsV2	D’ACCORD
Other Status Codes	DefaultErrorResponse	Réponse d’erreur App Service.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

List Auth Settings V2

Exemple de requête

HTTP

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsV2/list?api-version=2024-04-01

Java

/**
 * Samples for WebApps GetAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
     */
    /**
     * Sample code: List Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsV2WithResponse("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_auth_settings_v2.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_auth_settings_v2(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
func ExampleWebAppsClient_GetAuthSettingsV2() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetAuthSettingsV2(ctx, "testrg123", "sitef6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SiteAuthSettingsV2 = armappservice.SiteAuthSettingsV2{
	// 	Name: to.Ptr("authsettingsv2"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettingsv2"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsV2Properties{
	// 		GlobalValidation: &armappservice.GlobalValidation{
	// 			ExcludedPaths: []*string{
	// 				to.Ptr("/nosecrets/Path")},
	// 				RequireAuthentication: to.Ptr(true),
	// 				UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionV2Return403),
	// 			},
	// 			HTTPSettings: &armappservice.HTTPSettings{
	// 				ForwardProxy: &armappservice.ForwardProxy{
	// 					Convention: to.Ptr(armappservice.ForwardProxyConventionStandard),
	// 					CustomHostHeaderName: to.Ptr("authHeader"),
	// 					CustomProtoHeaderName: to.Ptr("customProtoHeader"),
	// 				},
	// 				RequireHTTPS: to.Ptr(true),
	// 				Routes: &armappservice.HTTPSettingsRoutes{
	// 					APIPrefix: to.Ptr("/authv2/"),
	// 				},
	// 			},
	// 			IdentityProviders: &armappservice.IdentityProviders{
	// 				Google: &armappservice.Google{
	// 					Enabled: to.Ptr(true),
	// 					Login: &armappservice.LoginScopes{
	// 						Scopes: []*string{
	// 							to.Ptr("admin")},
	// 						},
	// 						Registration: &armappservice.ClientRegistration{
	// 							ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 							ClientSecretSettingName: to.Ptr("ClientSecret"),
	// 						},
	// 						Validation: &armappservice.AllowedAudiencesValidation{
	// 							AllowedAudiences: []*string{
	// 								to.Ptr("https://example.com")},
	// 							},
	// 						},
	// 					},
	// 					Login: &armappservice.Login{
	// 						AllowedExternalRedirectUrls: []*string{
	// 							to.Ptr("https://someurl.com")},
	// 							CookieExpiration: &armappservice.CookieExpiration{
	// 								Convention: to.Ptr(armappservice.CookieExpirationConventionIdentityProviderDerived),
	// 								TimeToExpiration: to.Ptr("2022:09-01T00:00Z"),
	// 							},
	// 							Nonce: &armappservice.Nonce{
	// 								ValidateNonce: to.Ptr(true),
	// 							},
	// 							PreserveURLFragmentsForLogins: to.Ptr(true),
	// 							Routes: &armappservice.LoginRoutes{
	// 								LogoutEndpoint: to.Ptr("https://app.com/logout"),
	// 							},
	// 							TokenStore: &armappservice.TokenStore{
	// 								Enabled: to.Ptr(true),
	// 								FileSystem: &armappservice.FileSystemTokenStore{
	// 									Directory: to.Ptr("/wwwroot/sites/example"),
	// 								},
	// 								TokenRefreshExtensionHours: to.Ptr[float64](96),
	// 							},
	// 						},
	// 						Platform: &armappservice.AuthPlatform{
	// 							ConfigFilePath: to.Ptr("/auth/config.json"),
	// 							Enabled: to.Ptr(true),
	// 							RuntimeVersion: to.Ptr("~1"),
	// 						},
	// 					},
	// 				}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
 */
async function listAuthSettingsV2() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAuthSettingsV2(resourceGroupName, name);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
// this example is just showing the usage of "WebApps_GetAuthSettingsV2" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
SiteAuthSettingsV2 result = await webSite.GetAuthSettingsV2Async();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2",
  "name": "authsettingsv2",
  "type": "Microsoft.Web/sites/authsettingsv2",
  "kind": "app",
  "properties": {
    "platform": {
      "enabled": true,
      "runtimeVersion": "~1",
      "configFilePath": "/auth/config.json"
    },
    "globalValidation": {
      "requireAuthentication": true,
      "unauthenticatedClientAction": "Return403",
      "excludedPaths": [
        "/nosecrets/Path"
      ]
    },
    "identityProviders": {
      "google": {
        "enabled": true,
        "registration": {
          "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
          "clientSecretSettingName": "ClientSecret"
        },
        "login": {
          "scopes": [
            "admin"
          ]
        },
        "validation": {
          "allowedAudiences": [
            "https://example.com"
          ]
        }
      }
    },
    "login": {
      "routes": {
        "logoutEndpoint": "https://app.com/logout"
      },
      "tokenStore": {
        "enabled": true,
        "tokenRefreshExtensionHours": 96,
        "fileSystem": {
          "directory": "/wwwroot/sites/example"
        }
      },
      "preserveUrlFragmentsForLogins": true,
      "allowedExternalRedirectUrls": [
        "https://someurl.com"
      ],
      "cookieExpiration": {
        "convention": "IdentityProviderDerived",
        "timeToExpiration": "2022:09-01T00:00Z"
      },
      "nonce": {
        "validateNonce": true
      }
    },
    "httpSettings": {
      "requireHttps": true,
      "routes": {
        "apiPrefix": "/authv2/"
      },
      "forwardProxy": {
        "convention": "Standard",
        "customHostHeaderName": "authHeader",
        "customProtoHeaderName": "customProtoHeader"
      }
    }
  }
}

Définitions

Nom	Description
AllowedAudiencesValidation	Paramètres de configuration du flux de validation Audiences autorisées.
AllowedPrincipals	Paramètres de configuration des principaux autorisés Azure Active Directory.
Apple	Paramètres de configuration du fournisseur Apple.
AppleRegistration	Paramètres de configuration de l’inscription pour le fournisseur Apple
AppRegistration	Paramètres de configuration de l’inscription d’application pour les fournisseurs qui ont des ID d’application et des secrets d’application
AuthPlatform	Paramètres de configuration de la plateforme d’authentification/autorisation App Service.
AzureActiveDirectory	Paramètres de configuration du fournisseur Azure Active Directory.
AzureActiveDirectoryLogin	Paramètres de configuration du flux de connexion Azure Active Directory.
AzureActiveDirectoryRegistration	Paramètres de configuration de l’inscription d’application Azure Active Directory.
AzureActiveDirectoryValidation	Paramètres de configuration du flux de validation de jeton Azure Active Directory.
AzureStaticWebApps	Paramètres de configuration du fournisseur Azure Static Web Apps.
AzureStaticWebAppsRegistration	Paramètres de configuration de l’inscription pour le fournisseur Azure Static Web Apps
BlobStorageTokenStore	Paramètres de configuration du stockage des jetons si le stockage d’objets blob est utilisé.
ClientCredentialMethod	Méthode qui doit être utilisée pour authentifier l’utilisateur.
ClientRegistration	Paramètres de configuration de l’inscription d’application pour les fournisseurs qui ont des ID client et des secrets clients
CookieExpiration	Paramètres de configuration de l’expiration du cookie de session.
CookieExpirationConvention	Convention utilisée lors de la détermination de l’expiration du cookie de session.
CustomOpenIdConnectProvider	Paramètres de configuration du fournisseur Open ID Connect personnalisé.
DefaultAuthorizationPolicy	Paramètres de configuration de la stratégie d’autorisation par défaut Azure Active Directory.
DefaultErrorResponse	Réponse d’erreur App Service.
Details
Error	Modèle d’erreur.
Facebook	Paramètres de configuration du fournisseur Facebook.
FileSystemTokenStore	Paramètres de configuration du stockage des jetons si un système de fichiers est utilisé.
ForwardProxy	Paramètres de configuration d’un proxy de transfert utilisé pour effectuer les requêtes.
ForwardProxyConvention	Convention utilisée pour déterminer l’URL de la requête effectuée.
GitHub	Paramètres de configuration du fournisseur GitHub.
GlobalValidation	Paramètres de configuration qui déterminent le flux de validation des utilisateurs à l’aide de l’authentification/autorisation App Service.
Google	Paramètres de configuration du fournisseur Google.
HttpSettings	Paramètres de configuration des requêtes HTTP pour les demandes d’authentification et d’autorisation effectuées par rapport à l’authentification/autorisation App Service.
HttpSettingsRoutes	Paramètres de configuration des chemins d’accès aux requêtes HTTP.
IdentityProviders	Paramètres de configuration de chacun des fournisseurs d’identité utilisés pour configurer l’authentification/l’autorisation App Service.
JwtClaimChecks	Paramètres de configuration des vérifications à effectuer lors de la validation des revendications JWT.
LegacyMicrosoftAccount	Paramètres de configuration du fournisseur de compte Microsoft hérité.
Login	Paramètres de configuration du flux de connexion des utilisateurs à l’aide de l’authentification/autorisation App Service.
LoginRoutes	Itinéraires qui spécifient les points de terminaison utilisés pour les demandes de connexion et de déconnexion.
LoginScopes	Paramètres de configuration du flux de connexion, y compris les étendues qui doivent être demandées.
Nonce	Paramètres de configuration de la nonce utilisée dans le flux de connexion.
OpenIdConnectClientCredential	Informations d’identification du client d’authentification du fournisseur Open ID Connect personnalisé.
OpenIdConnectConfig	Paramètres de configuration des points de terminaison utilisés pour le fournisseur Open ID Connect personnalisé.
OpenIdConnectLogin	Paramètres de configuration du flux de connexion du fournisseur Open ID Connect personnalisé.
OpenIdConnectRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur Open ID Connect personnalisé.
SiteAuthSettingsV2	Paramètres de configuration de la fonctionnalité Azure App Service Authentication / Authorization V2.
TokenStore	Paramètres de configuration du magasin de jetons.
Twitter	Paramètres de configuration du fournisseur Twitter.
TwitterRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur Twitter.
UnauthenticatedClientActionV2	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.

AllowedAudiencesValidation

Object

Paramètres de configuration du flux de validation Audiences autorisées.

Nom	Type	Description
allowedAudiences	string[]	Paramètres de configuration de la liste autorisée d’audiences à partir de laquelle valider le jeton JWT.

AllowedPrincipals

Object

Paramètres de configuration des principaux autorisés Azure Active Directory.

Nom	Type	Description
groups	string[]	Liste des groupes autorisés.
identities	string[]	Liste des identités autorisées.

Apple

Object

Paramètres de configuration du fournisseur Apple.

Nom	Type	Description
enabled	boolean	false si le fournisseur Apple ne doit pas être activé malgré l’inscription définie ; sinon, true.
login	LoginScopes	Paramètres de configuration du flux de connexion.
registration	AppleRegistration	Paramètres de configuration de l’inscription Apple.

AppleRegistration

Object

Paramètres de configuration de l’inscription pour le fournisseur Apple

Nom	Type	Description
clientId	string	ID client de l’application utilisée pour la connexion.
clientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client.

AppRegistration

Object

Paramètres de configuration de l’inscription d’application pour les fournisseurs qui ont des ID d’application et des secrets d’application

Nom	Type	Description
appId	string	ID d’application de l’application utilisée pour la connexion.
appSecretSettingName	string	Nom du paramètre d’application qui contient le secret de l’application.

AuthPlatform

Object

Paramètres de configuration de la plateforme d’authentification/autorisation App Service.

Nom	Type	Description
configFilePath	string	Chemin du fichier de configuration contenant les paramètres d’authentification s’ils proviennent d’un fichier. Si le chemin d’accès est relatif, la base va le répertoire racine du site.
enabled	boolean	true si la fonctionnalité d’authentification/autorisation est activée pour l’application actuelle ; sinon, false.
runtimeVersion	string	RuntimeVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement de certaines fonctionnalités dans le module d’authentification/autorisation.

AzureActiveDirectory

Object

Paramètres de configuration du fournisseur Azure Active Directory.

Nom	Type	Description
enabled	boolean	false si le fournisseur Azure Active Directory ne doit pas être activé malgré l’inscription définie ; sinon, true.
isAutoProvisioned	boolean	Obtient une valeur indiquant si la configuration Azure AD a été configurée automatiquement à l’aide d’outils tiers. Il s’agit d’un indicateur interne principalement destiné à prendre en charge le portail de gestion Azure. Les utilisateurs ne doivent pas lire ou écrire dans cette propriété.
login	AzureActiveDirectoryLogin	Paramètres de configuration du flux de connexion Azure Active Directory.
registration	AzureActiveDirectoryRegistration	Paramètres de configuration de l’inscription d’application Azure Active Directory.
validation	AzureActiveDirectoryValidation	Paramètres de configuration du flux de validation de jeton Azure Active Directory.

AzureActiveDirectoryLogin

Object

Paramètres de configuration du flux de connexion Azure Active Directory.

Nom	Type	Description
disableWWWAuthenticate	boolean	true si le fournisseur www-authenticate doit être omis de la demande ; sinon, false.
loginParameters	string[]	Paramètres de connexion à envoyer au point de terminaison d’autorisation OpenID Connect lorsqu’un utilisateur se connecte. Chaque paramètre doit se trouver sous la forme « key=value ».

AzureActiveDirectoryRegistration

Object

Paramètres de configuration de l’inscription d’application Azure Active Directory.

Nom	Type	Description
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
clientSecretCertificateIssuer	string	Alternative à l’empreinte numérique du secret client, qui est l’émetteur d’un certificat utilisé à des fins de signature. Cette propriété remplace l’empreinte numérique du certificat secret client. Il est également facultatif.
clientSecretCertificateSubjectAlternativeName	string	Alternative à l’empreinte numérique de la clé secrète client, c’est-à-dire le nom de remplacement de l’objet d’un certificat utilisé à des fins de signature. Cette propriété remplace l’empreinte numérique du certificat secret client. Il est également facultatif.
clientSecretCertificateThumbprint	string	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. Il est également facultatif.
clientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client de l’application de partie de confiance.
openIdIssuer	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://login.microsoftonline.com/v2.0/{tenant-guid}/. Cet URI est un identificateur sensible à la casse pour l’émetteur de jeton. Plus d’informations sur la découverte OpenID Connect : http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Object

Paramètres de configuration du flux de validation de jeton Azure Active Directory.

Nom	Type	Description
allowedAudiences	string[]	Liste des audiences qui peuvent effectuer des demandes d’authentification/d’autorisation réussies.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Paramètres de configuration de la stratégie d’autorisation par défaut.
jwtClaimChecks	JwtClaimChecks	Paramètres de configuration des vérifications à effectuer lors de la validation des revendications JWT.

AzureStaticWebApps

Object

Paramètres de configuration du fournisseur Azure Static Web Apps.

Nom	Type	Description
enabled	boolean	false si le fournisseur Azure Static Web Apps ne doit pas être activé malgré l’inscription définie ; sinon, true.
registration	AzureStaticWebAppsRegistration	Paramètres de configuration de l’inscription Azure Static Web Apps.

AzureStaticWebAppsRegistration

Object

Paramètres de configuration de l’inscription pour le fournisseur Azure Static Web Apps

Nom	Type	Description
clientId	string	ID client de l’application utilisée pour la connexion.

BlobStorageTokenStore

Object

Paramètres de configuration du stockage des jetons si le stockage d’objets blob est utilisé.

Nom	Type	Description
sasUrlSettingName	string	Nom du paramètre d’application contenant l’URL SAP du stockage d’objets blob contenant les jetons.

ClientCredentialMethod

Enumeration

Méthode qui doit être utilisée pour authentifier l’utilisateur.

Valeur	Description
ClientSecretPost

ClientRegistration

Object

Paramètres de configuration de l’inscription d’application pour les fournisseurs qui ont des ID client et des secrets clients

Nom	Type	Description
clientId	string	ID client de l’application utilisée pour la connexion.
clientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client.

CookieExpiration

Object

Paramètres de configuration de l’expiration du cookie de session.

Nom	Type	Description
convention	CookieExpirationConvention	Convention utilisée lors de la détermination de l’expiration du cookie de session.
timeToExpiration	string	Heure à laquelle la demande est effectuée lorsque le cookie de session doit expirer.

CookieExpirationConvention

Enumeration

Convention utilisée lors de la détermination de l’expiration du cookie de session.

Valeur	Description
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

Paramètres de configuration du fournisseur Open ID Connect personnalisé.

Nom	Type	Description
enabled	boolean	false si le fournisseur de fournisseur Open ID personnalisé ne doit pas être activé ; sinon, true.
login	OpenIdConnectLogin	Paramètres de configuration du flux de connexion du fournisseur Open ID Connect personnalisé.
registration	OpenIdConnectRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur Open ID Connect personnalisé.

DefaultAuthorizationPolicy

Object

Paramètres de configuration de la stratégie d’autorisation par défaut Azure Active Directory.

Nom	Type	Description
allowedApplications	string[]	Paramètres de configuration des applications autorisées Azure Active Directory.
allowedPrincipals	AllowedPrincipals	Paramètres de configuration des principaux autorisés Azure Active Directory.

DefaultErrorResponse

Object

Réponse d’erreur App Service.

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

Details

Object

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

Error

Object

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	Pour plus d’informations sur l’erreur de débogage.
message	string	Description détaillée des erreurs et informations de débogage.
target	string	Description détaillée des erreurs et informations de débogage.

Facebook

Object

Paramètres de configuration du fournisseur Facebook.

Nom	Type	Description
enabled	boolean	false si le fournisseur Facebook ne doit pas être activé malgré l’inscription définie ; sinon, true.
graphApiVersion	string	Version de l’API Facebook à utiliser lors de la connexion.
login	LoginScopes	Paramètres de configuration du flux de connexion.
registration	AppRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur Facebook.

FileSystemTokenStore

Object

Paramètres de configuration du stockage des jetons si un système de fichiers est utilisé.

Nom	Type	Description
directory	string	Répertoire dans lequel les jetons seront stockés.

ForwardProxy

Object

Paramètres de configuration d’un proxy de transfert utilisé pour effectuer les requêtes.

Nom	Type	Description
convention	ForwardProxyConvention	Convention utilisée pour déterminer l’URL de la requête effectuée.
customHostHeaderName	string	Nom de l’en-tête contenant l’hôte de la requête.
customProtoHeaderName	string	Nom de l’en-tête contenant le schéma de la requête.

ForwardProxyConvention

Enumeration

Convention utilisée pour déterminer l’URL de la requête effectuée.

Valeur	Description
Custom
NoProxy
Standard

GitHub

Object

Paramètres de configuration du fournisseur GitHub.

Nom	Type	Description
enabled	boolean	false si le fournisseur GitHub ne doit pas être activé malgré l’inscription définie ; sinon, true.
login	LoginScopes	Paramètres de configuration du flux de connexion.
registration	ClientRegistration	Paramètres de configuration de l’inscription d’application pour le fournisseur GitHub.

GlobalValidation

Object

Paramètres de configuration qui déterminent le flux de validation des utilisateurs à l’aide de l’authentification/autorisation App Service.

Nom	Type	Description
excludedPaths	string[]	Chemins d’accès pour lesquels le flux non authentifié ne serait pas redirigé vers la page de connexion.
redirectToProvider	string	Fournisseur d’authentification par défaut à utiliser quand plusieurs fournisseurs sont configurés. Ce paramètre est nécessaire uniquement si plusieurs fournisseurs sont configurés et que l’action cliente non authentifiée est définie sur « RedirectToLoginPage ».
requireAuthentication	boolean	true si le flux d’authentification est requis pour effectuer une demande ; sinon, false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.

Google

Object

Paramètres de configuration du fournisseur Google.

Nom	Type	Description
enabled	boolean	false si le fournisseur Google ne doit pas être activé malgré l’inscription définie ; sinon, true.
login	LoginScopes	Paramètres de configuration du flux de connexion.
registration	ClientRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur Google.
validation	AllowedAudiencesValidation	Paramètres de configuration du flux de validation de jeton Azure Active Directory.

HttpSettings

Object

Paramètres de configuration des requêtes HTTP pour les demandes d’authentification et d’autorisation effectuées par rapport à l’authentification/autorisation App Service.

Nom	Type	Description
forwardProxy	ForwardProxy	Paramètres de configuration d’un proxy de transfert utilisé pour effectuer les requêtes.
requireHttps	boolean	false si les réponses d’authentification/autorisation ne disposant pas du schéma HTTPS sont autorisées ; sinon, true.
routes	HttpSettingsRoutes	Paramètres de configuration des chemins d’accès aux requêtes HTTP.

HttpSettingsRoutes

Object

Paramètres de configuration des chemins d’accès aux requêtes HTTP.

Nom	Type	Description
apiPrefix	string	Préfixe qui doit précéder tous les chemins d’authentification/autorisation.

IdentityProviders

Object

Paramètres de configuration de chacun des fournisseurs d’identité utilisés pour configurer l’authentification/l’autorisation App Service.

Nom	Type	Description
apple	Apple	Paramètres de configuration du fournisseur Apple.
azureActiveDirectory	AzureActiveDirectory	Paramètres de configuration du fournisseur Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	Paramètres de configuration du fournisseur Azure Static Web Apps.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Mappage du nom de l’alias de chaque fournisseur Open ID Connect personnalisé aux paramètres de configuration du fournisseur Open ID Connect personnalisé.
facebook	Facebook	Paramètres de configuration du fournisseur Facebook.
gitHub	GitHub	Paramètres de configuration du fournisseur GitHub.
google	Google	Paramètres de configuration du fournisseur Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Paramètres de configuration du fournisseur de compte Microsoft hérité.
twitter	Twitter	Paramètres de configuration du fournisseur Twitter.

JwtClaimChecks

Object

Paramètres de configuration des vérifications à effectuer lors de la validation des revendications JWT.

Nom	Type	Description
allowedClientApplications	string[]	Liste des applications clientes autorisées.
allowedGroups	string[]	Liste des groupes autorisés.

LegacyMicrosoftAccount

Object

Paramètres de configuration du fournisseur de compte Microsoft hérité.

Nom	Type	Description
enabled	boolean	false si le fournisseur de compte Microsoft hérité ne doit pas être activé malgré l’inscription définie ; sinon, true.
login	LoginScopes	Paramètres de configuration du flux de connexion.
registration	ClientRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur de compte Microsoft hérité.
validation	AllowedAudiencesValidation	Paramètres de configuration du flux de validation de jeton du fournisseur de compte Microsoft hérité.

Login

Object

Paramètres de configuration du flux de connexion des utilisateurs à l’aide de l’authentification/autorisation App Service.

Nom	Type	Description
allowedExternalRedirectUrls	string[]	URL externes pouvant ê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 nécessaire uniquement par les back-ends d’application du Windows Store. Notez que les URL du domaine actuel sont toujours implicitement autorisées.
cookieExpiration	CookieExpiration	Paramètres de configuration de l’expiration du cookie de session.
nonce	Nonce	Paramètres de configuration de la nonce utilisée dans le flux de connexion.
preserveUrlFragmentsForLogins	boolean	true si les fragments de la demande sont conservés une fois la demande de connexion effectuée ; sinon, false.
routes	LoginRoutes	Itinéraires qui spécifient les points de terminaison utilisés pour les demandes de connexion et de déconnexion.
tokenStore	TokenStore	Paramètres de configuration du magasin de jetons.

LoginRoutes

Object

Itinéraires qui spécifient les points de terminaison utilisés pour les demandes de connexion et de déconnexion.

Nom	Type	Description
logoutEndpoint	string	Point de terminaison auquel une demande de déconnexion doit être effectuée.

LoginScopes

Object

Paramètres de configuration du flux de connexion, y compris les étendues qui doivent être demandées.

Nom	Type	Description
scopes	string[]	Liste des étendues qui doivent être demandées lors de l’authentification.

Nonce

Object

Paramètres de configuration de la nonce utilisée dans le flux de connexion.

Nom	Type	Description
nonceExpirationInterval	string	Heure après l’expiration de la requête.
validateNonce	boolean	false si la nonce ne doit pas être validée lors de la fin du flux de connexion ; sinon, true.

OpenIdConnectClientCredential

Object

Informations d’identification du client d’authentification du fournisseur Open ID Connect personnalisé.

Nom	Type	Description
clientSecretSettingName	string	Paramètre d’application qui contient la clé secrète client pour le fournisseur Open ID Connect personnalisé.
method	ClientCredentialMethod	Méthode qui doit être utilisée pour authentifier l’utilisateur.

OpenIdConnectConfig

Object

Paramètres de configuration des points de terminaison utilisés pour le fournisseur Open ID Connect personnalisé.

Nom	Type	Description
authorizationEndpoint	string	Point de terminaison à utiliser pour effectuer une demande d’autorisation.
certificationUri	string	Point de terminaison qui fournit les clés nécessaires pour valider le jeton.
issuer	string	Point de terminaison qui émet le jeton.
tokenEndpoint	string	Point de terminaison à utiliser pour demander un jeton.
wellKnownOpenIdConfiguration	string	Point de terminaison qui contient tous les points de terminaison de configuration du fournisseur.

OpenIdConnectLogin

Object

Paramètres de configuration du flux de connexion du fournisseur Open ID Connect personnalisé.

Nom	Type	Description
nameClaimType	string	Nom de la revendication qui contient le nom des utilisateurs.
scopes	string[]	Liste des étendues qui doivent être demandées lors de l’authentification.

OpenIdConnectRegistration

Object

Paramètres de configuration de l’inscription de l’application pour le fournisseur Open ID Connect personnalisé.

Nom	Type	Description
clientCredential	OpenIdConnectClientCredential	Informations d’identification d’authentification du fournisseur Open ID Connect personnalisé.
clientId	string	ID client du fournisseur Open ID Connect personnalisé.
openIdConnectConfiguration	OpenIdConnectConfig	Paramètres de configuration des points de terminaison utilisés pour le fournisseur Open ID Connect personnalisé.

SiteAuthSettingsV2

Object

Paramètres de configuration de la fonctionnalité Azure App Service Authentication / Authorization V2.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.globalValidation	GlobalValidation	Paramètres de configuration qui déterminent le flux de validation des utilisateurs à l’aide de l’authentification/autorisation App Service.
properties.httpSettings	HttpSettings	Paramètres de configuration des requêtes HTTP pour les demandes d’authentification et d’autorisation effectuées par rapport à l’authentification/autorisation App Service.
properties.identityProviders	IdentityProviders	Paramètres de configuration de chacun des fournisseurs d’identité utilisés pour configurer l’authentification/l’autorisation App Service.
properties.login	Login	Paramètres de configuration du flux de connexion des utilisateurs à l’aide de l’authentification/autorisation App Service.
properties.platform	AuthPlatform	Paramètres de configuration de la plateforme d’authentification/autorisation App Service.
type	string	Type de ressource.

TokenStore

Object

Paramètres de configuration du magasin de jetons.

Nom	Type	Description
azureBlobStorage	BlobStorageTokenStore	Paramètres de configuration du stockage des jetons si le stockage d’objets blob est utilisé.
enabled	boolean	true pour stocker durablement des jetons de sécurité spécifiques à la plateforme obtenus pendant les flux de connexion ; sinon, false. La valeur par défaut est false.
fileSystem	FileSystemTokenStore	Paramètres de configuration du stockage des jetons si un système de fichiers est utilisé.
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.

Twitter

Object

Paramètres de configuration du fournisseur Twitter.

Nom	Type	Description
enabled	boolean	false si le fournisseur Twitter ne doit pas être activé malgré l’inscription définie ; sinon, true.
registration	TwitterRegistration	Paramètres de configuration de l’inscription de l’application pour le fournisseur Twitter.

TwitterRegistration

Object

Paramètres de configuration de l’inscription de l’application pour le fournisseur Twitter.

Nom	Type	Description
consumerKey	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 Sign-In Twitter : https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	Nom du paramètre d’application qui contient le secret consommateur OAuth 1.0a de l’application Twitter utilisée pour la connexion.

UnauthenticatedClientActionV2

Enumeration

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

Valeur	Description
AllowAnonymous
RedirectToLoginPage
Return401
Return403