Web Apps - Get Auth Settings

Referenz

Dienst:: App Service

API-Version:: 2023-12-01

Beschreibung für Ruft die Authentifizierungs-/Autorisierungseinstellungen einer App ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der App
resourceGroupName	path	True	string	Name der Ressourcengruppe, zu der die Ressource gehört. RegEx-Muster: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-Version

Antworten

Name	Typ	Beschreibung
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

List Auth Settings

Beispielanforderung

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


/**
 * Samples for WebApps GetAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-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/2023-12-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/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-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");

/**
 * 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/2023-12-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/2023-12-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

Beispiel für eine Antwort

Statuscode:: 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"
  }
}

Definitionen

Name	Beschreibung
BuiltInAuthenticationProvider	Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.
DefaultErrorResponse	App Service Fehlerantwort.
Details
Error	Fehlermodell.
SiteAuthSettings	Konfigurationseinstellungen für die Azure App Service-Authentifizierungs-/Autorisierungsfunktion.
UnauthenticatedClientAction	Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

BuiltInAuthenticationProvider

Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.

Name	Typ	Beschreibung
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

App Service Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen eines Fehlers.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

SiteAuthSettings

Konfigurationseinstellungen für die Azure App Service-Authentifizierungs-/Autorisierungsfunktion.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.aadClaimsAuthorization	string	Ruft eine JSON-Zeichenfolge ab, die die Azure AD-Acl-Einstellungen enthält.
properties.additionalLoginParams	string[]	Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss die Form "key=value" aufweisen.
properties.allowedAudiences	string[]	Zulässige Zielgruppenwerte, die beim Überprüfen von von Azure Active Directory ausgestellten JSON-Webtoken berücksichtigt werden. Beachten Sie, dass der `ClientID` Wert unabhängig von dieser Einstellung immer als zulässige Zielgruppe betrachtet wird.
properties.allowedExternalRedirectUrls	string[]	Externe URLs, die im Rahmen der Anmeldung oder Abmeldung der App umgeleitet werden können. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die normalerweise nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.
properties.authFilePath	string	Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält. Wenn der Pfad relativ ist, wird base das Stammverzeichnis der Website.
properties.clientId	string	Die Client-ID dieser Anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Der geheime Clientschlüssel dieser Anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet). Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite OpenID Connect-Authentifizierungsflow verwendet, um Endbenutzer zu authentifizieren. Andernfalls wird der OpenID Connect-Autorisierungscodeflow verwendet, um Endbenutzer zu authentifizieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.
properties.clientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.
properties.configVersion	string	Die ConfigVersion der Authentifizierungs-/Autorisierungsfunktion, die für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten der Steuerungsebene für Authentifizierung/Autorisierung steuern.
properties.defaultProvider	BuiltInAuthenticationProvider	Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.
properties.enabled	boolean	`true` , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; `false`andernfalls .
properties.facebookAppId	string	Die App-ID der Facebook App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um Facebook Anmeldung zu aktivieren. Facebook Anmeldedokumentation:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Das App-Geheimnis der Facebook App, die für Facebook Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um Facebook Anmeldung zu aktivieren. Facebook Anmeldedokumentation:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Der Name der App-Einstellung, der das app-Geheimnis enthält, das für Facebook Anmeldung verwendet wird.
properties.facebookOAuthScopes	string[]	Die OAuth 2.0-Bereiche, die im Rahmen der Facebook Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional. Facebook Anmeldedokumentation:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die GitHub-Anmeldung zu aktivieren.
properties.gitHubClientSecret	string	Der geheime Clientschlüssel der GitHub-App, die für die GitHub-Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die GitHub-Anmeldung zu aktivieren.
properties.gitHubClientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen Clientschlüssel der GitHub-App enthält, die für die GitHub-Anmeldung verwendet wird.
properties.gitHubOAuthScopes	string[]	Die OAuth 2.0-Bereiche, die im Rahmen der GitHub-Anmeldeauthentifizierung angefordert werden. Diese Einstellung ist optional.
properties.googleClientId	string	Die OpenID Connect-Client-ID für die Google-Webanwendung. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In-Dokumentation: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist. Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren. Google Sign-In-Dokumentation: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält, der der Google-Webanwendung zugeordnet ist.
properties.googleOAuthScopes	string[]	Die OAuth 2.0-Bereiche, die im Rahmen der Google-Sign-In-Authentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet. Google Sign-In-Dokumentation: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true", wenn die Konfigurationseinstellungen für die Authentifizierung aus einer Datei gelesen werden sollen, andernfalls "false"
properties.issuer	string	Der OpenID Connect-Aussteller-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://sts.windows.net/{tenant-guid}/. Bei diesem URI handelt es sich um einen Bezeichner, bei dem die Groß-/Kleinschreibung für den Tokenaussteller beachtet wird. Weitere Informationen zur OpenID Connect-Ermittlung: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde. Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren. Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die app erstellt wurde, die für die Authentifizierung verwendet wird.
properties.microsoftAccountOAuthScopes	string[]	Die OAuth 2.0-Bereiche, die im Rahmen der Microsoft-Kontoauthentifizierung angefordert werden. Diese Einstellung ist optional. Wenn nicht angegeben, wird "wl.basic" als Standardbereich verwendet. Dokumentation zu Microsoft-Kontobereichen und Berechtigungen: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	Die RuntimeVersion der Authentifizierungs-/Autorisierungsfunktion, die für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Modul Authentifizierung/Autorisierung steuern.
properties.tokenRefreshExtensionHours	number	Die Anzahl der Stunden nach Ablauf des Sitzungstokens, die ein Sitzungstoken zum Aufrufen der Tokenaktualisierungs-API verwendet werden kann. Die Standardeinstellung beträgt 72 Stunden.
properties.tokenStoreEnabled	boolean	`true` zum dauerhaften Speichern plattformspezifischer Sicherheitstoken, die während der Anmeldeflows abgerufen werden; `false`andernfalls . Der Standardwert lautet `false`.
properties.twitterConsumerKey	string	Der OAuth 1.0a-Consumerschlüssel der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Dokumentation zu Twitter-Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Das OAuth 1.0a-Consumergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Dokumentation zu Twitter-Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Der Name der App-Einstellung, der das OAuth 1.0a-Consumergeheimnis der twitter-Anwendung enthält, die für die Anmeldung verwendet wird.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.
properties.validateIssuer	boolean	Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein und als solcher überprüft werden soll.
type	string	Der Ressourcentyp.

UnauthenticatedClientAction

Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

Name	Typ	Beschreibung
AllowAnonymous	string
RedirectToLoginPage	string