Web Apps - Update Auth Settings V2

Služba:

App Service

Verze rozhraní API:

2024-04-01

Popis nastavení ověřování a autorizace webu Aktualizace pro aplikace ve formátu V2

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2?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.globalValidation	GlobalValidation	Nastavení konfigurace, které určuje tok ověřování uživatelů pomocí ověřování nebo autorizace služby App Service.
properties.httpSettings	HttpSettings	Nastavení konfigurace požadavků HTTP na ověřování a autorizaci provedených proti ověřování nebo autorizaci služby App Service.
properties.identityProviders	IdentityProviders	Nastavení konfigurace každého zprostředkovatele identity používaného ke konfiguraci ověřování nebo autorizace služby App Service.
properties.login	Login	Nastavení konfigurace toku přihlášení uživatelů pomocí ověřování nebo autorizace služby App Service.
properties.platform	AuthPlatform	Nastavení konfigurace platformy ověřování/autorizace služby App Service.

Odpovědi

Name	Typ	Description
200 OK	SiteAuthSettingsV2	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 V2

Ukázkový požadavek

HTTP

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

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

Java

import com.azure.resourcemanager.appservice.fluent.models.SiteAuthSettingsV2Inner;
import com.azure.resourcemanager.appservice.models.AllowedAudiencesValidation;
import com.azure.resourcemanager.appservice.models.AuthPlatform;
import com.azure.resourcemanager.appservice.models.ClientRegistration;
import com.azure.resourcemanager.appservice.models.CookieExpiration;
import com.azure.resourcemanager.appservice.models.CookieExpirationConvention;
import com.azure.resourcemanager.appservice.models.FileSystemTokenStore;
import com.azure.resourcemanager.appservice.models.ForwardProxy;
import com.azure.resourcemanager.appservice.models.ForwardProxyConvention;
import com.azure.resourcemanager.appservice.models.GlobalValidation;
import com.azure.resourcemanager.appservice.models.Google;
import com.azure.resourcemanager.appservice.models.HttpSettings;
import com.azure.resourcemanager.appservice.models.HttpSettingsRoutes;
import com.azure.resourcemanager.appservice.models.IdentityProviders;
import com.azure.resourcemanager.appservice.models.Login;
import com.azure.resourcemanager.appservice.models.LoginRoutes;
import com.azure.resourcemanager.appservice.models.LoginScopes;
import com.azure.resourcemanager.appservice.models.Nonce;
import com.azure.resourcemanager.appservice.models.TokenStore;
import com.azure.resourcemanager.appservice.models.UnauthenticatedClientActionV2;
import java.util.Arrays;

/**
 * Samples for WebApps UpdateAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json
     */
    /**
     * Sample code: Update Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().updateAuthSettingsV2WithResponse("testrg123",
            "sitef6141",
            new SiteAuthSettingsV2Inner()
                .withPlatform(new AuthPlatform().withEnabled(true).withRuntimeVersion("~1")
                    .withConfigFilePath("/auth/config.json"))
                .withGlobalValidation(new GlobalValidation().withRequireAuthentication(true)
                    .withUnauthenticatedClientAction(UnauthenticatedClientActionV2.RETURN403)
                    .withExcludedPaths(Arrays.asList("/nosecrets/Path")))
                .withIdentityProviders(new IdentityProviders().withGoogle(new Google().withEnabled(true)
                    .withRegistration(new ClientRegistration()
                        .withClientId("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com")
                        .withClientSecretSettingName("fakeTokenPlaceholder"))
                    .withLogin(new LoginScopes().withScopes(Arrays.asList("admin"))).withValidation(
                        new AllowedAudiencesValidation().withAllowedAudiences(Arrays.asList("https://example.com")))))
                .withLogin(new Login().withRoutes(new LoginRoutes().withLogoutEndpoint("https://app.com/logout"))
                    .withTokenStore(new TokenStore().withEnabled(true).withTokenRefreshExtensionHours(96.0D)
                        .withFileSystem(new FileSystemTokenStore().withDirectory("/wwwroot/sites/example")))
                    .withPreserveUrlFragmentsForLogins(true)
                    .withAllowedExternalRedirectUrls(Arrays.asList("https://someurl.com"))
                    .withCookieExpiration(
                        new CookieExpiration().withConvention(CookieExpirationConvention.IDENTITY_PROVIDER_DERIVED)
                            .withTimeToExpiration("2022:09-01T00:00Z"))
                    .withNonce(new Nonce().withValidateNonce(true)))
                .withHttpSettings(new HttpSettings().withRequireHttps(true)
                    .withRoutes(new HttpSettingsRoutes().withApiPrefix("/authv2/"))
                    .withForwardProxy(new ForwardProxy().withConvention(ForwardProxyConvention.STANDARD)
                        .withCustomHostHeaderName("authHeader").withCustomProtoHeaderName("customProtoHeader"))),
            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_v2.py

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


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

    response = client.web_apps.update_auth_settings_v2(
        resource_group_name="testrg123",
        name="sitef6141",
        site_auth_settings_v2={
            "properties": {
                "globalValidation": {
                    "excludedPaths": ["/nosecrets/Path"],
                    "requireAuthentication": True,
                    "unauthenticatedClientAction": "Return403",
                },
                "httpSettings": {
                    "forwardProxy": {
                        "convention": "Standard",
                        "customHostHeaderName": "authHeader",
                        "customProtoHeaderName": "customProtoHeader",
                    },
                    "requireHttps": True,
                    "routes": {"apiPrefix": "/authv2/"},
                },
                "identityProviders": {
                    "google": {
                        "enabled": True,
                        "login": {"scopes": ["admin"]},
                        "registration": {
                            "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
                            "clientSecretSettingName": "ClientSecret",
                        },
                        "validation": {"allowedAudiences": ["https://example.com"]},
                    }
                },
                "login": {
                    "allowedExternalRedirectUrls": ["https://someurl.com"],
                    "cookieExpiration": {
                        "convention": "IdentityProviderDerived",
                        "timeToExpiration": "2022:09-01T00:00Z",
                    },
                    "nonce": {"validateNonce": True},
                    "preserveUrlFragmentsForLogins": True,
                    "routes": {"logoutEndpoint": "https://app.com/logout"},
                    "tokenStore": {
                        "enabled": True,
                        "fileSystem": {"directory": "/wwwroot/sites/example"},
                        "tokenRefreshExtensionHours": 96,
                    },
                },
                "platform": {"configFilePath": "/auth/config.json", "enabled": True, "runtimeVersion": "~1"},
            }
        },
    )
    print(response)


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

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

JavaScript

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

/**
 * This sample demonstrates how to Description for Updates site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Updates site's Authentication / Authorization settings for apps via the V2 format
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json
 */
async function updateAuthSettingsV2() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const siteAuthSettingsV2 = {
    globalValidation: {
      excludedPaths: ["/nosecrets/Path"],
      requireAuthentication: true,
      unauthenticatedClientAction: "Return403",
    },
    httpSettings: {
      forwardProxy: {
        convention: "Standard",
        customHostHeaderName: "authHeader",
        customProtoHeaderName: "customProtoHeader",
      },
      requireHttps: true,
      routes: { apiPrefix: "/authv2/" },
    },
    identityProviders: {
      google: {
        enabled: true,
        login: { scopes: ["admin"] },
        registration: {
          clientId: "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
          clientSecretSettingName: "ClientSecret",
        },
        validation: { allowedAudiences: ["https://example.com"] },
      },
    },
    login: {
      allowedExternalRedirectUrls: ["https://someurl.com"],
      cookieExpiration: {
        convention: "IdentityProviderDerived",
        timeToExpiration: "2022:09-01T00:00Z",
      },
      nonce: { validateNonce: true },
      preserveUrlFragmentsForLogins: true,
      routes: { logoutEndpoint: "https://app.com/logout" },
      tokenStore: {
        enabled: true,
        fileSystem: { directory: "/wwwroot/sites/example" },
        tokenRefreshExtensionHours: 96,
      },
    },
    platform: {
      configFilePath: "/auth/config.json",
      enabled: true,
      runtimeVersion: "~1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.updateAuthSettingsV2(
    resourceGroupName,
    name,
    siteAuthSettingsV2,
  );
  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/UpdateAuthSettingsV2.json
// this example is just showing the usage of "WebApps_UpdateAuthSettingsV2" operation, for the dependent resources, they will have to be created separately.

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

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

// invoke the operation
SiteAuthSettingsV2 siteAuthSettingsV2 = new SiteAuthSettingsV2()
{
    Platform = new AuthPlatform()
    {
        IsEnabled = true,
        RuntimeVersion = "~1",
        ConfigFilePath = "/auth/config.json",
    },
    GlobalValidation = new GlobalValidation()
    {
        IsAuthenticationRequired = true,
        UnauthenticatedClientAction = UnauthenticatedClientActionV2.Return403,
        ExcludedPaths =
        {
        "/nosecrets/Path"
        },
    },
    IdentityProviders = new AppServiceIdentityProviders()
    {
        Google = new AppServiceGoogleProvider()
        {
            IsEnabled = true,
            Registration = new ClientRegistration()
            {
                ClientId = "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
                ClientSecretSettingName = "ClientSecret",
            },
            LoginScopes =
            {
            "admin"
            },
            ValidationAllowedAudiences =
            {
            "https://example.com"
            },
        },
    },
    Login = new WebAppLoginInfo()
    {
        RoutesLogoutEndpoint = "https://app.com/logout",
        TokenStore = new AppServiceTokenStore()
        {
            IsEnabled = true,
            TokenRefreshExtensionHours = 96,
            FileSystemDirectory = "/wwwroot/sites/example",
        },
        PreserveUrlFragmentsForLogins = true,
        AllowedExternalRedirectUrls =
        {
        "https://someurl.com"
        },
        CookieExpiration = new WebAppCookieExpiration()
        {
            Convention = CookieExpirationConvention.IdentityProviderDerived,
            TimeToExpiration = "2022:09-01T00:00Z",
        },
        Nonce = new LoginFlowNonceSettings()
        {
            ValidateNonce = true,
        },
    },
    HttpSettings = new AppServiceHttpSettings()
    {
        IsHttpsRequired = true,
        RoutesApiPrefix = "/authv2/",
        ForwardProxy = new AppServiceForwardProxy()
        {
            Convention = ForwardProxyConvention.Standard,
            CustomHostHeaderName = "authHeader",
            CustomProtoHeaderName = "customProtoHeader",
        },
    },
};
SiteAuthSettingsV2 result = await webSite.UpdateAuthSettingsV2Async(siteAuthSettingsV2);

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

Definice

Name	Description
AllowedAudiencesValidation	Nastavení konfigurace toku ověření povolených cílových skupin
AllowedPrincipals	Nastavení konfigurace povolených objektů zabezpečení Azure Active Directory.
Apple	Nastavení konfigurace poskytovatele Apple
AppleRegistration	Nastavení konfigurace registrace pro poskytovatele Apple
AppRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele, kteří mají ID aplikace a tajné kódy aplikací
AuthPlatform	Nastavení konfigurace platformy ověřování/autorizace služby App Service.
AzureActiveDirectory	Nastavení konfigurace poskytovatele Azure Active Directory.
AzureActiveDirectoryLogin	Nastavení konfigurace toku přihlášení k Azure Active Directory.
AzureActiveDirectoryRegistration	Nastavení konfigurace registrace aplikace Azure Active Directory.
AzureActiveDirectoryValidation	Nastavení konfigurace toku ověření tokenu Azure Active Directory.
AzureStaticWebApps	Nastavení konfigurace poskytovatele Azure Static Web Apps.
AzureStaticWebAppsRegistration	Nastavení konfigurace registrace pro poskytovatele Azure Static Web Apps
BlobStorageTokenStore	Nastavení konfigurace úložiště tokenů, pokud se používá úložiště objektů blob.
ClientCredentialMethod	Metoda, která by se měla použít k ověření uživatele.
ClientRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele, kteří mají ID klienta a tajné kódy klienta
CookieExpiration	Nastavení konfigurace vypršení platnosti souboru cookie relace.
CookieExpirationConvention	Konvence použitá při určování vypršení platnosti souboru cookie relace.
CustomOpenIdConnectProvider	Nastavení konfigurace vlastního zprostředkovatele Open ID Connect.
DefaultAuthorizationPolicy	Nastavení konfigurace výchozích zásad autorizace Azure Active Directory
DefaultErrorResponse	Odpověď na chybu služby App Service
Details
Error	Chybový model
Facebook	Nastavení konfigurace poskytovatele Facebooku.
FileSystemTokenStore	Nastavení konfigurace úložiště tokenů, pokud se používá systém souborů.
ForwardProxy	Nastavení konfigurace předávaného proxy serveru použitého k provádění požadavků.
ForwardProxyConvention	Konvence použitá k určení adresy URL provedené žádosti.
GitHub	Nastavení konfigurace poskytovatele GitHubu
GlobalValidation	Nastavení konfigurace, které určuje tok ověřování uživatelů pomocí ověřování nebo autorizace služby App Service.
Google	Nastavení konfigurace poskytovatele Google.
HttpSettings	Nastavení konfigurace požadavků HTTP na ověřování a autorizaci provedených proti ověřování nebo autorizaci služby App Service.
HttpSettingsRoutes	Nastavení konfigurace cest požadavků HTTP.
IdentityProviders	Nastavení konfigurace každého zprostředkovatele identity používaného ke konfiguraci ověřování nebo autorizace služby App Service.
JwtClaimChecks	Nastavení konfigurace kontrol, které by se měly provést při ověřování deklarací identity JWT.
LegacyMicrosoftAccount	Nastavení konfigurace staršího poskytovatele účtu Microsoft.
Login	Nastavení konfigurace toku přihlášení uživatelů pomocí ověřování nebo autorizace služby App Service.
LoginRoutes	Trasy, které určují koncové body používané pro žádosti o přihlášení a odhlášení.
LoginScopes	Nastavení konfigurace toku přihlášení, včetně oborů, které by se měly požadovat.
Nonce	Nastavení konfigurace nepoužívaného v toku přihlášení.
OpenIdConnectClientCredential	Přihlašovací údaje ověřovacího klienta vlastního zprostředkovatele Open ID Connect.
OpenIdConnectConfig	Nastavení konfigurace koncových bodů používaných pro vlastního zprostředkovatele Open ID Connect.
OpenIdConnectLogin	Nastavení konfigurace toku přihlášení vlastního zprostředkovatele Open ID Connect.
OpenIdConnectRegistration	Nastavení konfigurace registrace aplikace pro vlastního zprostředkovatele Open ID Connect.
SiteAuthSettingsV2	Nastavení konfigurace pro funkci ověřování / autorizace služby Azure App Service V2
TokenStore	Nastavení konfigurace úložiště tokenů.
Twitter	Nastavení konfigurace poskytovatele Twitteru
TwitterRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele Twitteru.
UnauthenticatedClientActionV2	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.

AllowedAudiencesValidation

Object

Nastavení konfigurace toku ověření povolených cílových skupin

Name	Typ	Description
allowedAudiences	string[]	Nastavení konfigurace seznamu povolených cílových skupin, ze kterých se má ověřit token JWT.

AllowedPrincipals

Object

Nastavení konfigurace povolených objektů zabezpečení Azure Active Directory.

Name	Typ	Description
groups	string[]	Seznam povolených skupin.
identities	string[]	Seznam povolených identit.

Apple

Object

Nastavení konfigurace poskytovatele Apple

Name	Typ	Description
enabled	boolean	false, pokud by poskytovatel Apple neměl být povolen bez ohledu na nastavenou registraci; jinak true.
login	LoginScopes	Nastavení konfigurace toku přihlášení.
registration	AppleRegistration	Nastavení konfigurace registrace Apple.

AppleRegistration

Object

Nastavení konfigurace registrace pro poskytovatele Apple

Name	Typ	Description
clientId	string	ID klienta aplikace použité k přihlášení.
clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta.

AppRegistration

Object

Nastavení konfigurace registrace aplikace pro poskytovatele, kteří mají ID aplikace a tajné kódy aplikací

Name	Typ	Description
appId	string	ID aplikace použité k přihlášení.
appSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč aplikace.

AuthPlatform

Object

Nastavení konfigurace platformy ověřování/autorizace služby App Service.

Name	Typ	Description
configFilePath	string	Cesta konfiguračního souboru obsahujícího nastavení ověřování, pokud pocházejí ze souboru. Pokud je cesta relativní, základ bude kořenový adresář webu.
enabled	boolean	true, pokud je pro aktuální aplikaci povolená funkce ověřování nebo autorizace; jinak false.
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.

AzureActiveDirectory

Object

Nastavení konfigurace poskytovatele Azure Active Directory.

Name	Typ	Description
enabled	boolean	false, pokud by zprostředkovatel Azure Active Directory neměl být povolen bez ohledu na nastavenou registraci; jinak true.
isAutoProvisioned	boolean	Získá hodnotu označující, jestli byla konfigurace Azure AD automaticky zřízena pomocí nástrojů první strany. Jedná se o interní příznak, který primárně slouží k podpoře portálu pro správu Azure. Uživatelé by do této vlastnosti neměli číst ani zapisovat.
login	AzureActiveDirectoryLogin	Nastavení konfigurace toku přihlášení k Azure Active Directory.
registration	AzureActiveDirectoryRegistration	Nastavení konfigurace registrace aplikace Azure Active Directory.
validation	AzureActiveDirectoryValidation	Nastavení konfigurace toku ověření tokenu Azure Active Directory.

AzureActiveDirectoryLogin

Object

Nastavení konfigurace toku přihlášení k Azure Active Directory.

Name	Typ	Description
disableWWWAuthenticate	boolean	true, pokud by z požadavku neměl být vynechán poskytovatel www-authenticate; jinak false.
loginParameters	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".

AzureActiveDirectoryRegistration

Object

Nastavení konfigurace registrace aplikace Azure Active Directory.

Name	Typ	Description
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
clientSecretCertificateIssuer	string	Alternativou k kryptografickému otisku tajného klíče klienta, který je vystavitelem certifikátu používaného pro podpisové účely. Tato vlastnost slouží jako náhrada kryptografického otisku certifikátu tajného klíče klienta. Je také nepovinný.
clientSecretCertificateSubjectAlternativeName	string	Alternativou k kryptografickému otisku tajného klíče klienta je alternativní název certifikátu použitého k podepisování. Tato vlastnost slouží jako náhrada kryptografického otisku certifikátu tajného klíče klienta. Je také nepovinný.
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ý.
clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta aplikace předávající strany.
openIdIssuer	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://login.microsoftonline.com/v2.0/{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

AzureActiveDirectoryValidation

Object

Nastavení konfigurace toku ověření tokenu Azure Active Directory.

Name	Typ	Description
allowedAudiences	string[]	Seznam cílových skupin, které můžou provádět úspěšné žádosti o ověření nebo autorizaci.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Nastavení konfigurace výchozích zásad autorizace.
jwtClaimChecks	JwtClaimChecks	Nastavení konfigurace kontrol, které by se měly provést při ověřování deklarací identity JWT.

AzureStaticWebApps

Object

Nastavení konfigurace poskytovatele Azure Static Web Apps.

Name	Typ	Description
enabled	boolean	false, pokud by zprostředkovatel Azure Static Web Apps neměl být povolen bez ohledu na nastavenou registraci; jinak true.
registration	AzureStaticWebAppsRegistration	Nastavení konfigurace registrace azure Static Web Apps.

AzureStaticWebAppsRegistration

Object

Nastavení konfigurace registrace pro poskytovatele Azure Static Web Apps

Name	Typ	Description
clientId	string	ID klienta aplikace použité k přihlášení.

BlobStorageTokenStore

Object

Nastavení konfigurace úložiště tokenů, pokud se používá úložiště objektů blob.

Name	Typ	Description
sasUrlSettingName	string	Název nastavení aplikace obsahující adresu URL SAS úložiště objektů blob obsahujícího tokeny.

ClientCredentialMethod

Enumeration

Metoda, která by se měla použít k ověření uživatele.

Hodnota	Description
ClientSecretPost

ClientRegistration

Object

Nastavení konfigurace registrace aplikace pro poskytovatele, kteří mají ID klienta a tajné kódy klienta

Name	Typ	Description
clientId	string	ID klienta aplikace použité k přihlášení.
clientSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný klíč klienta.

CookieExpiration

Object

Nastavení konfigurace vypršení platnosti souboru cookie relace.

Name	Typ	Description
convention	CookieExpirationConvention	Konvence použitá při určování vypršení platnosti souboru cookie relace.
timeToExpiration	string	Čas po provedení požadavku, kdy má platnost souboru cookie relace vypršet.

CookieExpirationConvention

Enumeration

Konvence použitá při určování vypršení platnosti souboru cookie relace.

Hodnota	Description
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

Nastavení konfigurace vlastního zprostředkovatele Open ID Connect.

Name	Typ	Description
enabled	boolean	false, pokud by neměl být povolený vlastní zprostředkovatel zprostředkovatele Open ID; jinak true.
login	OpenIdConnectLogin	Nastavení konfigurace toku přihlášení vlastního zprostředkovatele Open ID Connect.
registration	OpenIdConnectRegistration	Nastavení konfigurace registrace aplikace pro vlastního zprostředkovatele Open ID Connect.

DefaultAuthorizationPolicy

Object

Nastavení konfigurace výchozích zásad autorizace Azure Active Directory

Name	Typ	Description
allowedApplications	string[]	Nastavení konfigurace povolených aplikací Azure Active Directory.
allowedPrincipals	AllowedPrincipals	Nastavení konfigurace povolených objektů zabezpečení Azure Active Directory.

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í

Facebook

Object

Nastavení konfigurace poskytovatele Facebooku.

Name	Typ	Description
enabled	boolean	false, pokud by poskytovatel Facebooku neměl být povolen i přes nastavenou registraci; jinak true.
graphApiVersion	string	Verze rozhraní API pro Facebook, která se má použít při přihlašování.
login	LoginScopes	Nastavení konfigurace toku přihlášení.
registration	AppRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele Facebooku.

FileSystemTokenStore

Object

Nastavení konfigurace úložiště tokenů, pokud se používá systém souborů.

Name	Typ	Description
directory	string	Adresář, ve kterém budou tokeny uloženy.

ForwardProxy

Object

Nastavení konfigurace předávaného proxy serveru použitého k provádění požadavků.

Name	Typ	Description
convention	ForwardProxyConvention	Konvence použitá k určení adresy URL provedené žádosti.
customHostHeaderName	string	Název hlavičky obsahující hostitele požadavku.
customProtoHeaderName	string	Název hlavičky obsahující schéma požadavku.

ForwardProxyConvention

Enumeration

Konvence použitá k určení adresy URL provedené žádosti.

Hodnota	Description
Custom
NoProxy
Standard

GitHub

Object

Nastavení konfigurace poskytovatele GitHubu

Name	Typ	Description
enabled	boolean	false, pokud by zprostředkovatel GitHubu neměl být povolen bez ohledu na nastavenou registraci; jinak true.
login	LoginScopes	Nastavení konfigurace toku přihlášení.
registration	ClientRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele GitHubu

GlobalValidation

Object

Nastavení konfigurace, které určuje tok ověřování uživatelů pomocí ověřování nebo autorizace služby App Service.

Name	Typ	Description
excludedPaths	string[]	Cesty, pro které se neověřený tok nepřesměruje na přihlašovací stránku.
redirectToProvider	string	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.
requireAuthentication	boolean	true, pokud se vyžaduje jakýkoli požadavek na ověření; jinak false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Akce, která se má provést, když se neověřený klient pokusí o přístup k aplikaci.

Google

Object

Nastavení konfigurace poskytovatele Google.

Name	Typ	Description
enabled	boolean	false, pokud by poskytovatel Google neměl být povolen bez ohledu na nastavenou registraci; jinak true.
login	LoginScopes	Nastavení konfigurace toku přihlášení.
registration	ClientRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele Google.
validation	AllowedAudiencesValidation	Nastavení konfigurace toku ověření tokenu Azure Active Directory.

HttpSettings

Object

Nastavení konfigurace požadavků HTTP na ověřování a autorizaci provedených proti ověřování nebo autorizaci služby App Service.

Name	Typ	Description
forwardProxy	ForwardProxy	Nastavení konfigurace předávaného proxy serveru použitého k provádění požadavků.
requireHttps	boolean	false, pokud jsou povolené odpovědi na ověřování nebo autorizaci, které nemají schéma HTTPS; jinak true.
routes	HttpSettingsRoutes	Nastavení konfigurace cest požadavků HTTP.

HttpSettingsRoutes

Object

Nastavení konfigurace cest požadavků HTTP.

Name	Typ	Description
apiPrefix	string	Předpona, která by měla předcházet všem cestám ověřování/autorizace.

IdentityProviders

Object

Nastavení konfigurace každého zprostředkovatele identity používaného ke konfiguraci ověřování nebo autorizace služby App Service.

Name	Typ	Description
apple	Apple	Nastavení konfigurace poskytovatele Apple
azureActiveDirectory	AzureActiveDirectory	Nastavení konfigurace poskytovatele Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	Nastavení konfigurace poskytovatele Azure Static Web Apps.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Mapa názvu aliasu každého vlastního zprostředkovatele Open ID Connect na konfigurační nastavení vlastního zprostředkovatele Open ID Connect
facebook	Facebook	Nastavení konfigurace poskytovatele Facebooku.
gitHub	GitHub	Nastavení konfigurace poskytovatele GitHubu
google	Google	Nastavení konfigurace poskytovatele Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Nastavení konfigurace staršího poskytovatele účtu Microsoft.
twitter	Twitter	Nastavení konfigurace poskytovatele Twitteru

JwtClaimChecks

Object

Nastavení konfigurace kontrol, které by se měly provést při ověřování deklarací identity JWT.

Name	Typ	Description
allowedClientApplications	string[]	Seznam povolených klientských aplikací
allowedGroups	string[]	Seznam povolených skupin.

LegacyMicrosoftAccount

Object

Nastavení konfigurace staršího poskytovatele účtu Microsoft.

Name	Typ	Description
enabled	boolean	false, pokud by starší verze poskytovatele účtu Microsoft neměla být povolena bez ohledu na nastavenou registraci; jinak true.
login	LoginScopes	Nastavení konfigurace toku přihlášení.
registration	ClientRegistration	Nastavení konfigurace registrace aplikace pro staršího poskytovatele účtu Microsoft.
validation	AllowedAudiencesValidation	Nastavení konfigurace starší verze toku ověření tokenu zprostředkovatele účtu Microsoft.

Login

Object

Nastavení konfigurace toku přihlášení uživatelů pomocí ověřování nebo autorizace služby App Service.

Name	Typ	Description
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é.
cookieExpiration	CookieExpiration	Nastavení konfigurace vypršení platnosti souboru cookie relace.
nonce	Nonce	Nastavení konfigurace nepoužívaného v toku přihlášení.
preserveUrlFragmentsForLogins	boolean	true, pokud se fragmenty z požadavku zachovají po provedení žádosti o přihlášení; jinak false.
routes	LoginRoutes	Trasy, které určují koncové body používané pro žádosti o přihlášení a odhlášení.
tokenStore	TokenStore	Nastavení konfigurace úložiště tokenů.

LoginRoutes

Object

Trasy, které určují koncové body používané pro žádosti o přihlášení a odhlášení.

Name	Typ	Description
logoutEndpoint	string	Koncový bod, na kterém se má provést žádost o odhlášení.

LoginScopes

Object

Nastavení konfigurace toku přihlášení, včetně oborů, které by se měly požadovat.

Name	Typ	Description
scopes	string[]	Seznam oborů, které by měly být požadovány při ověřování.

Nonce

Object

Nastavení konfigurace nepoužívaného v toku přihlášení.

Name	Typ	Description
nonceExpirationInterval	string	Doba, po které je žádost provedena, kdy má platnost nonce vypršet.
validateNonce	boolean	false, pokud by se při dokončování toku přihlášení neověřila hodnota nonce; jinak true.

OpenIdConnectClientCredential

Object

Přihlašovací údaje ověřovacího klienta vlastního zprostředkovatele Open ID Connect.

Name	Typ	Description
clientSecretSettingName	string	Nastavení aplikace, které obsahuje tajný klíč klienta pro vlastního zprostředkovatele Open ID Connect.
method	ClientCredentialMethod	Metoda, která by se měla použít k ověření uživatele.

OpenIdConnectConfig

Object

Nastavení konfigurace koncových bodů používaných pro vlastního zprostředkovatele Open ID Connect.

Name	Typ	Description
authorizationEndpoint	string	Koncový bod, který se má použít k provedení žádosti o autorizaci.
certificationUri	string	Koncový bod, který poskytuje klíče potřebné k ověření tokenu.
issuer	string	Koncový bod, který token vydává.
tokenEndpoint	string	Koncový bod, který se má použít k vyžádání tokenu.
wellKnownOpenIdConfiguration	string	Koncový bod, který obsahuje všechny koncové body konfigurace pro zprostředkovatele.

OpenIdConnectLogin

Object

Nastavení konfigurace toku přihlášení vlastního zprostředkovatele Open ID Connect.

Name	Typ	Description
nameClaimType	string	Název deklarace identity, která obsahuje uživatelské jméno.
scopes	string[]	Seznam oborů, které by měly být požadovány při ověřování.

OpenIdConnectRegistration

Object

Nastavení konfigurace registrace aplikace pro vlastního zprostředkovatele Open ID Connect.

Name	Typ	Description
clientCredential	OpenIdConnectClientCredential	Přihlašovací údaje pro ověření vlastního zprostředkovatele Open ID Connect.
clientId	string	ID klienta vlastního zprostředkovatele Open ID Connect.
openIdConnectConfiguration	OpenIdConnectConfig	Nastavení konfigurace koncových bodů používaných pro vlastního zprostředkovatele Open ID Connect.

SiteAuthSettingsV2

Object

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

Name	Typ	Description
id	string	ID prostředku.
kind	string	Druh prostředku.
name	string	Název prostředku
properties.globalValidation	GlobalValidation	Nastavení konfigurace, které určuje tok ověřování uživatelů pomocí ověřování nebo autorizace služby App Service.
properties.httpSettings	HttpSettings	Nastavení konfigurace požadavků HTTP na ověřování a autorizaci provedených proti ověřování nebo autorizaci služby App Service.
properties.identityProviders	IdentityProviders	Nastavení konfigurace každého zprostředkovatele identity používaného ke konfiguraci ověřování nebo autorizace služby App Service.
properties.login	Login	Nastavení konfigurace toku přihlášení uživatelů pomocí ověřování nebo autorizace služby App Service.
properties.platform	AuthPlatform	Nastavení konfigurace platformy ověřování/autorizace služby App Service.
type	string	Typ prostředku.

TokenStore

Object

Nastavení konfigurace úložiště tokenů.

Name	Typ	Description
azureBlobStorage	BlobStorageTokenStore	Nastavení konfigurace úložiště tokenů, pokud se používá úložiště objektů blob.
enabled	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.
fileSystem	FileSystemTokenStore	Nastavení konfigurace úložiště tokenů, pokud se používá systém souborů.
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.

Twitter

Object

Nastavení konfigurace poskytovatele Twitteru

Name	Typ	Description
enabled	boolean	false, pokud by poskytovatel Twitteru neměl být povolen bez ohledu na nastavenou registraci; jinak true.
registration	TwitterRegistration	Nastavení konfigurace registrace aplikace pro poskytovatele Twitteru.

TwitterRegistration

Object

Nastavení konfigurace registrace aplikace pro poskytovatele Twitteru.

Name	Typ	Description
consumerKey	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
consumerSecretSettingName	string	Název nastavení aplikace, který obsahuje tajný kód uživatele OAuth 1.0a aplikace Twitter používané k přihlášení.

UnauthenticatedClientActionV2

Enumeration

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

Hodnota	Description
AllowAnonymous
RedirectToLoginPage
Return401
Return403