Web Apps - Get Auth Settings

Référence

Service:: App Service

Version d'API:: 2024-04-01

Description pour Obtenir les paramètres d’authentification/autorisation d’une application.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/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	SiteAuthSettings	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

Exemple de requête

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


/**
 * Samples for WebApps GetAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
     */
    /**
     * Sample code: List Auth Settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsWithResponse("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

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.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(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.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

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/ListAuthSettings.json
func ExampleWebAppsClient_GetAuthSettings() {
	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().GetAuthSettings(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.SiteAuthSettings = armappservice.SiteAuthSettings{
	// 	Name: to.Ptr("authsettings"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettings"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsProperties{
	// 		AllowedExternalRedirectUrls: []*string{
	// 			to.Ptr("sitef6141.customdomain.net"),
	// 			to.Ptr("sitef6141.customdomain.info")},
	// 			ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 			DefaultProvider: to.Ptr(armappservice.BuiltInAuthenticationProviderGoogle),
	// 			Enabled: to.Ptr(true),
	// 			RuntimeVersion: to.Ptr("~1"),
	// 			TokenRefreshExtensionHours: to.Ptr[float64](120),
	// 			TokenStoreEnabled: to.Ptr(true),
	// 			UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionRedirectToLoginPage),
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Description for Gets the Authentication/Authorization settings of an app.
 *
 * @summary Description for Gets the Authentication/Authorization settings of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
 */
async function listAuthSettings() {
  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.getAuthSettings(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

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/ListAuthSettings.json
// this example is just showing the usage of "WebApps_GetAuthSettings" 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
SiteAuthSettings result = await webSite.GetAuthSettingsAsync();

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/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 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 ».
DefaultErrorResponse	Réponse d’erreur App Service.
Details
Error	Modèle d’erreur.
SiteAuthSettings	Paramètres de configuration de la fonctionnalité d’authentification/autorisation Azure App Service.
UnauthenticatedClientAction	Action à entreprendre lorsqu’un client non authentifié tente d’accéder à l’application.

BuiltInAuthenticationProvider

Enumeration

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 ».

Valeur	Description
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

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.

SiteAuthSettings

Object

Paramètres de configuration de 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 se trouver sous 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 valeur `ClientID` est toujours considérée comme un public autorisé, quel que soit ce paramètre.
properties.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.
properties.authFilePath	string	Chemin du fichier de configuration contenant les paramètres d’authentification. Si le chemin d’accès est relatif, la base va 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	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.
properties.clientSecretSettingName	string	Nom du paramètre d’application qui contient la clé secrète client de l’application de partie de confiance.
properties.configVersion	string	ConfigVersion de la fonctionnalité d’authentification/autorisation utilisée pour l’application actuelle. Le paramètre de cette valeur peut contrôler le comportement du plan de contrôle pour l’authentification/autorisation.
properties.defaultProvider	BuiltInAuthenticationProvider	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 ».
properties.enabled	boolean	`true` si la fonctionnalité d’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 la connexion Facebook. 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 la connexion Facebook. 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 La connexion Facebook.
properties.facebookOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion Facebook. 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	Clé secrète client de l’application GitHub utilisée pour Github Login. 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 GitHub Login.
properties.gitHubOAuthScopes	string[]	Étendues OAuth 2.0 qui seront demandées dans le cadre de l’authentification de connexion GitHub. 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’il n’est pas spécifié, « openid », « profil » et « e-mail » 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 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
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 de compte Microsoft. Documentation OAuth du compte Microsoft : https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Secret client OAuth 2.0 créé pour l’application utilisée pour l’authentification. Ce paramètre est requis pour activer l’authentification de 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 des comptes Microsoft : https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.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.
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 des jetons de sécurité spécifiques à la plateforme obtenus pendant les flux de connexion ; sinon, `false`. La valeur par défaut est `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 Sign-In Twitter : 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 Sign-In Twitter : 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ée en tant que telle.
type	string	Type de ressource.

UnauthenticatedClientAction

Enumeration

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

Valeur	Description
AllowAnonymous
RedirectToLoginPage