Web Apps - Update Auth Settings

Služba:

App Service

Verze rozhraní API:

2024-04-01

Popis aktualizace nastavení ověřování nebo autorizace přidružené k webové aplikaci

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
name	path	True	string	Název webové aplikace
resourceGroupName	path	True	string	Název skupiny prostředků, do které prostředek patří. Vzor regulárního výrazu: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	ID vašeho předplatného Azure. Jedná se o řetězec formátovaný identifikátorem GUID (např. 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Verze rozhraní API

Text požadavku

Name	Typ	Description
kind	string	Druh prostředku.
properties.aadClaimsAuthorization	string	Získá řetězec JSON obsahující nastavení seznamu Acl služby Azure AD.
properties.additionalLoginParams	string[]	Přihlašovací parametry pro odeslání do koncového bodu autorizace OpenID Connect, když se uživatel přihlásí. Každý parametr musí být ve tvaru "key=value".
properties.allowedAudiences	string[]	Povolené hodnoty cílové skupiny je možné zvážit při ověřování webových tokenů JSON vydaných službou Azure Active Directory. Všimněte si, že hodnota ClientID se vždy považuje za povolenou cílovou skupinu bez ohledu na toto nastavení.
properties.allowedExternalRedirectUrls	string[]	Externí adresy URL, které je možné přesměrovat jako součást přihlášení nebo odhlášení z aplikace. Všimněte si, že část řetězce dotazu adresy URL je ignorována. Jedná se o upřesňující nastavení, které obvykle potřebují jenom back-endy aplikací pro Windows Store. Mějte na paměti, že adresy URL v aktuální doméně jsou vždy implicitně povolené.
properties.authFilePath	string	Cesta konfiguračního souboru obsahujícího nastavení ověřování. Pokud je cesta relativní, základ bude kořenový adresář webu.
properties.clientId	string	ID klienta této aplikace předávající strany označované jako client_id. Toto nastavení se vyžaduje pro povolení ověřování připojení OpenID pomocí Azure Active Directory nebo jiných poskytovatelů OpenID Connect třetích stran. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Tajný klíč klienta této aplikace předávající strany (v Azure Active Directory se označuje také jako klíč). Toto nastavení je volitelné. Pokud není nakonfigurovaný žádný tajný klíč klienta, použije se k ověřování koncových uživatelů tok implicitního ověřování OpenID Connect. Jinak se k ověřování koncových uživatelů použije tok autorizačního kódu OpenID Connect. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativou k tajnému klíči klienta je kryptografický otisk certifikátu používaného pro podpisové účely. Tato vlastnost slouží jako náhrada tajného klíče klienta. Je také nepovinný.
properties.clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace předávající strany.
properties.configVersion	string	Konfigurace Verze funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování roviny řízení pro ověřování nebo autorizaci.
properties.defaultProvider	BuiltInAuthenticationProvider	Výchozí zprostředkovatel ověřování, který se má použít při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více poskytovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.
properties.enabled	boolean	true, pokud je pro aktuální aplikaci povolená funkce ověřování nebo autorizace; jinak false.
properties.facebookAppId	string	ID aplikace facebookové aplikace použité k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k Facebooku. Dokumentace k přihlášení k Facebooku: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Tajný kód aplikace facebookové aplikace, která se používá pro přihlášení k Facebooku. Toto nastavení se vyžaduje pro povolení přihlášení k Facebooku. Dokumentace k přihlášení k Facebooku: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód aplikace používaný pro přihlášení k Facebooku.
properties.facebookOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování přihlášení k Facebooku. Toto nastavení je volitelné. Dokumentace k přihlášení k Facebooku: https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID klienta aplikace GitHub používané k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k GitHubu.
properties.gitHubClientSecret	string	Tajný klíč klienta aplikace GitHub používané pro přihlášení k GitHubu. Toto nastavení se vyžaduje pro povolení přihlášení k GitHubu.
properties.gitHubClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace GitHub používané pro přihlášení k GitHubu.
properties.gitHubOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování githubu pro přihlášení. Toto nastavení je volitelné.
properties.googleClientId	string	ID klienta OpenID Connect pro webovou aplikaci Google. Toto nastavení se vyžaduje pro povolení přihlášení Google. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Tajný klíč klienta přidružený k webové aplikaci Google. Toto nastavení se vyžaduje pro povolení přihlášení Google. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta přidružený k webové aplikaci Google.
properties.googleOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování Google Sign-In. Toto nastavení je volitelné. Pokud nezadáte, jako výchozí obory se použijí "openid", "profile" a "email". Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	True, pokud by se nastavení konfigurace ověřování mělo číst ze souboru, jinak false
properties.issuer	string	Identifikátor URI vystavitele OpenID Connect, který představuje entitu, která vydává přístupové tokeny pro tuto aplikaci. Při použití Azure Active Directory je tato hodnota identifikátor URI tenanta adresáře, například https://sts.windows.net/{tenant-guid}/. Tento identifikátor URI rozlišuje malá a velká písmena pro vystavitele tokenu. Další informace o zjišťování OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID klienta OAuth 2.0, které se vytvořilo pro aplikaci použitou k ověřování. Toto nastavení se vyžaduje pro povolení ověřování účtu Microsoft. Dokumentace k OAuth účtu Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci použitou k ověřování. Toto nastavení se vyžaduje pro povolení ověřování účtu Microsoft. Dokumentace k OAuth účtu Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Název nastavení aplikace obsahující tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci použitou k ověřování.
properties.microsoftAccountOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování účtu Microsoft. Toto nastavení je volitelné. Pokud není zadaný, použije se jako výchozí obor "wl.basic". Dokumentace k rozsahům a oprávněním účtu Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování určitých funkcí v modulu ověřování a autorizace.
properties.tokenRefreshExtensionHours	number	Počet hodin od vypršení platnosti tokenu relace, který lze použít k volání rozhraní API pro aktualizaci tokenu. Výchozí hodnota je 72 hodin.
properties.tokenStoreEnabled	boolean	true trvale ukládat tokeny zabezpečení specifické pro platformu, které se získávají během přihlašovacích toků; jinak false. Výchozí hodnota je false.
properties.twitterConsumerKey	string	Uživatelský klíč OAuth 1.0a aplikace Twitter, který se používá pro přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k Twitteru. Dokumentace ke službě Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Tajný kód uživatele OAuth 1.0a aplikace Twitter, který se používá k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k Twitteru. Dokumentace ke službě Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód uživatele OAuth 1.0a aplikace Twitter používané k přihlášení.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.
properties.validateIssuer	boolean	Získá hodnotu určující, zda vystavitel by měl být platnou adresu URL HTTPS a být ověřen jako takový.

Odpovědi

Name	Typ	Description
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	Odpověď na chybu služby App Service

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Update Auth Settings

Ukázkový požadavek

HTTP

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

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

Java

import com.azure.resourcemanager.appservice.fluent.models.SiteAuthSettingsInner;
import com.azure.resourcemanager.appservice.models.BuiltInAuthenticationProvider;
import com.azure.resourcemanager.appservice.models.UnauthenticatedClientAction;
import java.util.Arrays;

/**
 * Samples for WebApps UpdateAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json
     */
    /**
     * Sample code: Update Auth Settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAuthSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().updateAuthSettingsWithResponse("testrg123", "sitef6141",
            new SiteAuthSettingsInner().withEnabled(true).withRuntimeVersion("~1")
                .withUnauthenticatedClientAction(UnauthenticatedClientAction.REDIRECT_TO_LOGIN_PAGE)
                .withTokenStoreEnabled(true)
                .withAllowedExternalRedirectUrls(
                    Arrays.asList("sitef6141.customdomain.net", "sitef6141.customdomain.info"))
                .withDefaultProvider(BuiltInAuthenticationProvider.GOOGLE).withTokenRefreshExtensionHours(120.0D)
                .withClientId("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
            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 update_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.update_auth_settings(
        resource_group_name="testrg123",
        name="sitef6141",
        site_auth_settings={
            "properties": {
                "allowedExternalRedirectUrls": ["sitef6141.customdomain.net", "sitef6141.customdomain.info"],
                "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
                "defaultProvider": "Google",
                "enabled": True,
                "runtimeVersion": "~1",
                "tokenRefreshExtensionHours": 120,
                "tokenStoreEnabled": True,
                "unauthenticatedClientAction": "RedirectToLoginPage",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.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/azcore/to"
	"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/UpdateAuthSettings.json
func ExampleWebAppsClient_UpdateAuthSettings() {
	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().UpdateAuthSettings(ctx, "testrg123", "sitef6141", armappservice.SiteAuthSettings{
		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),
		},
	}, 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

JavaScript

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

/**
 * This sample demonstrates how to Description for Updates the Authentication / Authorization settings associated with web app.
 *
 * @summary Description for Updates the Authentication / Authorization settings associated with web app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettings.json
 */
async function updateAuthSettings() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const siteAuthSettings = {
    allowedExternalRedirectUrls: ["sitef6141.customdomain.net", "sitef6141.customdomain.info"],
    clientId: "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
    defaultProvider: "Google",
    enabled: true,
    runtimeVersion: "~1",
    tokenRefreshExtensionHours: 120,
    tokenStoreEnabled: true,
    unauthenticatedClientAction: "RedirectToLoginPage",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.updateAuthSettings(resourceGroupName, name, siteAuthSettings);
  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/UpdateAuthSettings.json
// this example is just showing the usage of "WebApps_UpdateAuthSettings" 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 siteAuthSettings = new SiteAuthSettings()
{
    IsEnabled = true,
    RuntimeVersion = "~1",
    UnauthenticatedClientAction = UnauthenticatedClientAction.RedirectToLoginPage,
    IsTokenStoreEnabled = true,
    AllowedExternalRedirectUrls =
    {
    "sitef6141.customdomain.net","sitef6141.customdomain.info"
    },
    DefaultProvider = BuiltInAuthenticationProvider.Google,
    TokenRefreshExtensionHours = 120,
    ClientId = "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
};
SiteAuthSettings result = await webSite.UpdateAuthSettingsAsync(siteAuthSettings);

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
BuiltInAuthenticationProvider	Výchozí zprostředkovatel ověřování, který se má použít při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více poskytovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.
DefaultErrorResponse	Odpověď na chybu služby App Service
Details
Error	Chybový model
SiteAuthSettings	Nastavení konfigurace pro funkci ověřování nebo autorizace služby Azure App Service
UnauthenticatedClientAction	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.

BuiltInAuthenticationProvider

Enumeration

Výchozí zprostředkovatel ověřování, který se má použít při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více poskytovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.

Hodnota	Description
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

DefaultErrorResponse

Object

Odpověď na chybu služby App Service

Name	Typ	Description
error	Error	Chybový model

Details

Object

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

Error

Object

Chybový model

Name	Typ	Description
code	string	Standardizovaný řetězec pro programovou identifikaci chyby.
details	Details[]	Podrobné chyby.
innererror	string	Další informace o ladění chyby
message	string	Podrobný popis chyby a informace o ladění
target	string	Podrobný popis chyby a informace o ladění

SiteAuthSettings

Object

Nastavení konfigurace pro funkci ověřování nebo autorizace služby Azure App Service

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
name	string	Název prostředku
properties.aadClaimsAuthorization	string	Získá řetězec JSON obsahující nastavení seznamu Acl služby Azure AD.
properties.additionalLoginParams	string[]	Přihlašovací parametry pro odeslání do koncového bodu autorizace OpenID Connect, když se uživatel přihlásí. Každý parametr musí být ve tvaru "key=value".
properties.allowedAudiences	string[]	Povolené hodnoty cílové skupiny je možné zvážit při ověřování webových tokenů JSON vydaných službou Azure Active Directory. Všimněte si, že hodnota ClientID se vždy považuje za povolenou cílovou skupinu bez ohledu na toto nastavení.
properties.allowedExternalRedirectUrls	string[]	Externí adresy URL, které je možné přesměrovat jako součást přihlášení nebo odhlášení z aplikace. Všimněte si, že část řetězce dotazu adresy URL je ignorována. Jedná se o upřesňující nastavení, které obvykle potřebují jenom back-endy aplikací pro Windows Store. Mějte na paměti, že adresy URL v aktuální doméně jsou vždy implicitně povolené.
properties.authFilePath	string	Cesta konfiguračního souboru obsahujícího nastavení ověřování. Pokud je cesta relativní, základ bude kořenový adresář webu.
properties.clientId	string	ID klienta této aplikace předávající strany označované jako client_id. Toto nastavení se vyžaduje pro povolení ověřování připojení OpenID pomocí Azure Active Directory nebo jiných poskytovatelů OpenID Connect třetích stran. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Tajný klíč klienta této aplikace předávající strany (v Azure Active Directory se označuje také jako klíč). Toto nastavení je volitelné. Pokud není nakonfigurovaný žádný tajný klíč klienta, použije se k ověřování koncových uživatelů tok implicitního ověřování OpenID Connect. Jinak se k ověřování koncových uživatelů použije tok autorizačního kódu OpenID Connect. Další informace o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativou k tajnému klíči klienta je kryptografický otisk certifikátu používaného pro podpisové účely. Tato vlastnost slouží jako náhrada tajného klíče klienta. Je také nepovinný.
properties.clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace předávající strany.
properties.configVersion	string	Konfigurace Verze funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování roviny řízení pro ověřování nebo autorizaci.
properties.defaultProvider	BuiltInAuthenticationProvider	Výchozí zprostředkovatel ověřování, který se má použít při konfiguraci více zprostředkovatelů. Toto nastavení je potřeba jenom v případě, že je nakonfigurovaných více poskytovatelů a neověřená akce klienta je nastavená na RedirectToLoginPage.
properties.enabled	boolean	true, pokud je pro aktuální aplikaci povolená funkce ověřování nebo autorizace; jinak false.
properties.facebookAppId	string	ID aplikace facebookové aplikace použité k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k Facebooku. Dokumentace k přihlášení k Facebooku: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Tajný kód aplikace facebookové aplikace, která se používá pro přihlášení k Facebooku. Toto nastavení se vyžaduje pro povolení přihlášení k Facebooku. Dokumentace k přihlášení k Facebooku: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód aplikace používaný pro přihlášení k Facebooku.
properties.facebookOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování přihlášení k Facebooku. Toto nastavení je volitelné. Dokumentace k přihlášení k Facebooku: https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID klienta aplikace GitHub používané k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k GitHubu.
properties.gitHubClientSecret	string	Tajný klíč klienta aplikace GitHub používané pro přihlášení k GitHubu. Toto nastavení se vyžaduje pro povolení přihlášení k GitHubu.
properties.gitHubClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace GitHub používané pro přihlášení k GitHubu.
properties.gitHubOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování githubu pro přihlášení. Toto nastavení je volitelné.
properties.googleClientId	string	ID klienta OpenID Connect pro webovou aplikaci Google. Toto nastavení se vyžaduje pro povolení přihlášení Google. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Tajný klíč klienta přidružený k webové aplikaci Google. Toto nastavení se vyžaduje pro povolení přihlášení Google. Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta přidružený k webové aplikaci Google.
properties.googleOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování Google Sign-In. Toto nastavení je volitelné. Pokud nezadáte, jako výchozí obory se použijí "openid", "profile" a "email". Dokumentace ke službě Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	True, pokud by se nastavení konfigurace ověřování mělo číst ze souboru, jinak false
properties.issuer	string	Identifikátor URI vystavitele OpenID Connect, který představuje entitu, která vydává přístupové tokeny pro tuto aplikaci. Při použití Azure Active Directory je tato hodnota identifikátor URI tenanta adresáře, například https://sts.windows.net/{tenant-guid}/. Tento identifikátor URI rozlišuje malá a velká písmena pro vystavitele tokenu. Další informace o zjišťování OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID klienta OAuth 2.0, které se vytvořilo pro aplikaci použitou k ověřování. Toto nastavení se vyžaduje pro povolení ověřování účtu Microsoft. Dokumentace k OAuth účtu Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci použitou k ověřování. Toto nastavení se vyžaduje pro povolení ověřování účtu Microsoft. Dokumentace k OAuth účtu Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Název nastavení aplikace obsahující tajný klíč klienta OAuth 2.0, který byl vytvořen pro aplikaci použitou k ověřování.
properties.microsoftAccountOAuthScopes	string[]	Obory OAuth 2.0, které budou požadovány jako součást ověřování účtu Microsoft. Toto nastavení je volitelné. Pokud není zadaný, použije se jako výchozí obor "wl.basic". Dokumentace k rozsahům a oprávněním účtu Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion funkce ověřování / autorizace, která se používá pro aktuální aplikaci. Nastavení v této hodnotě může řídit chování určitých funkcí v modulu ověřování a autorizace.
properties.tokenRefreshExtensionHours	number	Počet hodin od vypršení platnosti tokenu relace, který lze použít k volání rozhraní API pro aktualizaci tokenu. Výchozí hodnota je 72 hodin.
properties.tokenStoreEnabled	boolean	true trvale ukládat tokeny zabezpečení specifické pro platformu, které se získávají během přihlašovacích toků; jinak false. Výchozí hodnota je false.
properties.twitterConsumerKey	string	Uživatelský klíč OAuth 1.0a aplikace Twitter, který se používá pro přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k Twitteru. Dokumentace ke službě Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Tajný kód uživatele OAuth 1.0a aplikace Twitter, který se používá k přihlášení. Toto nastavení se vyžaduje pro povolení přihlášení k Twitteru. Dokumentace ke službě Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód uživatele OAuth 1.0a aplikace Twitter používané k přihlášení.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.
properties.validateIssuer	boolean	Získá hodnotu určující, zda vystavitel by měl být platnou adresu URL HTTPS a být ověřen jako takový.
type	string	Typ prostředku.

UnauthenticatedClientAction

Enumeration

Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.

Hodnota	Description
AllowAnonymous
RedirectToLoginPage