Web Apps - Get Auth Settings

Odwołanie

Usługa:: App Service

Wersja interfejsu API:: 2024-04-01

Opis pobierania ustawień uwierzytelniania/autoryzacji aplikacji.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa aplikacji.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nazwa grupy zasobów, do której należy zasób.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List Auth Settings

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
  }
}

Definicje

Nazwa	Opis
BuiltInAuthenticationProvider	Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców i ustawiono nieuwierzytelnione działanie klienta na wartość "RedirectToLoginPage".
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
SiteAuthSettings	Ustawienia konfiguracji funkcji uwierzytelniania/autoryzacji usługi Azure App Service.
UnauthenticatedClientAction	Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.

BuiltInAuthenticationProvider

Wyliczanie

Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców i ustawiono nieuwierzytelnione działanie klienta na wartość "RedirectToLoginPage".

Wartość	Opis
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

SiteAuthSettings

Objekt

Ustawienia konfiguracji funkcji uwierzytelniania/autoryzacji usługi Azure App Service.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.aadClaimsAuthorization	string	Pobiera ciąg JSON zawierający ustawienia listy Acl usługi Azure AD.
properties.additionalLoginParams	string[]	Parametry logowania wysyłane do punktu końcowego autoryzacji openID Connect podczas logowania użytkownika. Każdy parametr musi mieć postać "key=value".
properties.allowedAudiences	string[]	Dozwolone wartości odbiorców do rozważenia podczas weryfikowania tokenów sieci Web JSON wystawionych przez usługę Azure Active Directory. Należy pamiętać, że wartość `ClientID` jest zawsze traktowana jako dozwolona grupa odbiorców, niezależnie od tego ustawienia.
properties.allowedExternalRedirectUrls	string[]	Zewnętrzne adresy URL, do których można przekierować w ramach logowania lub wylogowywania się z aplikacji. Należy pamiętać, że część ciągu zapytania adresu URL jest ignorowana. Jest to zaawansowane ustawienie zwykle wymagane tylko przez zaplecza aplikacji ze Sklepu Windows. Należy pamiętać, że adresy URL w bieżącej domenie są zawsze niejawnie dozwolone.
properties.authFilePath	string	Ścieżka pliku konfiguracji zawierającego ustawienia uwierzytelniania. Jeśli ścieżka jest względna, baza będzie katalog główny lokacji.
properties.clientId	string	Identyfikator klienta tej aplikacji jednostki uzależnionej, znany jako client_id. To ustawienie jest wymagane do włączenia uwierzytelniania połączenia OpenID za pomocą usługi Azure Active Directory lub innych dostawców openID Connect innych firm. Więcej informacji na temat openID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Klucz tajny klienta tej aplikacji jednostki uzależnionej (w usłudze Azure Active Directory jest to również nazywane kluczem). To ustawienie jest opcjonalne. Jeśli klucz tajny klienta nie jest skonfigurowany, niejawny przepływ uwierzytelniania openID Connect jest używany do uwierzytelniania użytkowników końcowych. W przeciwnym razie przepływ kodu autoryzacji OpenID Connect jest używany do uwierzytelniania użytkowników końcowych. Więcej informacji na temat openID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternatywą dla klucza tajnego klienta jest odcisk palca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zamiennik klucza tajnego klienta. Jest również opcjonalny.
properties.clientSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca klucz tajny klienta aplikacji jednostki uzależnionej.
properties.configVersion	string	ConfigVersion funkcji Uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie płaszczyzny sterowania na potrzeby uwierzytelniania/autoryzacji.
properties.defaultProvider	BuiltInAuthenticationProvider	Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców i ustawiono nieuwierzytelnione działanie klienta na wartość "RedirectToLoginPage".
properties.enabled	boolean	`true`, jeśli dla bieżącej aplikacji jest włączona funkcja uwierzytelnianie/autoryzacja; w przeciwnym razie `false`.
properties.facebookAppId	string	Identyfikator aplikacji facebook używanej do logowania. To ustawienie jest wymagane do włączenia logowania do serwisu Facebook. Dokumentacja logowania do serwisu Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Wpis tajny aplikacji facebook używanej do logowania do serwisu Facebook. To ustawienie jest wymagane do włączenia logowania do serwisu Facebook. Dokumentacja logowania do serwisu Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca wpis tajny aplikacji używany na potrzeby logowania do serwisu Facebook.
properties.facebookOAuthScopes	string[]	Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania logowania do serwisu Facebook. To ustawienie jest opcjonalne. Dokumentacja logowania do serwisu Facebook: https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	Identyfikator klienta aplikacji GitHub używanej do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze GitHub
properties.gitHubClientSecret	string	Wpis tajny klienta aplikacji GitHub używany do logowania w usłudze GitHub. To ustawienie jest wymagane do włączenia logowania w usłudze GitHub.
properties.gitHubClientSecretSettingName	string	Nazwa ustawienia aplikacji, która zawiera klucz tajny klienta aplikacji Github używanej do logowania w usłudze GitHub.
properties.gitHubOAuthScopes	string[]	Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania logowania w usłudze GitHub. To ustawienie jest opcjonalne
properties.googleClientId	string	Identyfikator klienta OpenID Connect dla aplikacji internetowej Google. To ustawienie jest wymagane do włączenia logowania Google. Dokumentacja usługi Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Wpis tajny klienta skojarzony z aplikacją internetową Google. To ustawienie jest wymagane do włączenia logowania Google. Dokumentacja usługi Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca klucz tajny klienta skojarzony z aplikacją internetową Google.
properties.googleOAuthScopes	string[]	Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania usługi Google Sign-In. To ustawienie jest opcjonalne. Jeśli nie zostanie określony, wartości "openid", "profile" i "email" są używane jako zakresy domyślne. Dokumentacja usługi Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true", jeśli ustawienia konfiguracji uwierzytelniania powinny być odczytywane z pliku, "false" w przeciwnym razie
properties.issuer	string	Identyfikator URI wystawcy OpenID Connect reprezentujący jednostkę, która wystawia tokeny dostępu dla tej aplikacji. W przypadku korzystania z usługi Azure Active Directory ta wartość jest identyfikatorem URI dzierżawy katalogu, np. `https://sts.windows.net/{tenant-guid}/`. Ten identyfikator URI jest identyfikatorem z uwzględnieniem wielkości liter dla wystawcy tokenu. Więcej informacji na temat odnajdywania OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	Identyfikator klienta OAuth 2.0 utworzony dla aplikacji używanej do uwierzytelniania. To ustawienie jest wymagane do włączenia uwierzytelniania konta Microsoft. Dokumentacja protokołu OAuth konta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Wpis tajny klienta OAuth 2.0, który został utworzony dla aplikacji używanej do uwierzytelniania. To ustawienie jest wymagane do włączenia uwierzytelniania konta Microsoft. Dokumentacja protokołu OAuth konta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca wpis tajny klienta OAuth 2.0, który został utworzony dla aplikacji używanej do uwierzytelniania.
properties.microsoftAccountOAuthScopes	string[]	Zakresy protokołu OAuth 2.0, które będą wymagane w ramach uwierzytelniania konta Microsoft. To ustawienie jest opcjonalne. Jeśli nie zostanie określony, parametr "wl.basic" jest używany jako zakres domyślny. Dokumentacja zakresów i uprawnień konta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion funkcji uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie niektórych funkcji w module Uwierzytelnianie/autoryzacja.
properties.tokenRefreshExtensionHours	number (double)	Liczba godzin po wygaśnięciu tokenu sesji, za pomocą którego można wywołać interfejs API odświeżania tokenu. Wartość domyślna to 72 godziny.
properties.tokenStoreEnabled	boolean	`true` trwałe przechowywanie tokenów zabezpieczających specyficznych dla platformy, które są uzyskiwane podczas przepływów logowania; w przeciwnym razie `false`. Wartość domyślna to `false`.
properties.twitterConsumerKey	string	Klucz użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Wpis tajny użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca wpis tajny użytkownika OAuth 1.0a aplikacji Twitter używany do logowania.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.
properties.validateIssuer	boolean	Pobiera wartość wskazującą, czy wystawca powinien być prawidłowym adresem URL PROTOKOŁU HTTPS i zostać zweryfikowany jako taki.
type	string	Typ zasobu.

UnauthenticatedClientAction

Wyliczanie

Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.

Wartość	Opis
AllowAnonymous
RedirectToLoginPage