Web Apps - Update Auth Settings V2

Service:

App Service

API-versie:

2024-04-01

Beschrijving voor de verificatie-/autorisatie-instellingen van de site updates voor apps via de V2-indeling

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

URI-parameters

Name	In	Vereist	Type	Description
name	path	True	string	Naam van web-app.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Naam van de resourcegroep waartoe de resource behoort.
subscriptionId	path	True	string	Uw Azure-abonnements-id. Dit is een tekenreeks met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000).
api-version	query	True	string	API-versie

Aanvraagbody

Name	Type	Description
kind	string	Soort resource.
properties.globalValidation	GlobalValidation	De configuratie-instellingen waarmee de validatiestroom van gebruikers wordt bepaald met behulp van App Service-verificatie/-autorisatie.
properties.httpSettings	HttpSettings	De configuratie-instellingen van de HTTP-aanvragen voor verificatie- en autorisatieaanvragen die zijn gedaan op basis van App Service-verificatie/-autorisatie.
properties.identityProviders	IdentityProviders	De configuratie-instellingen van elk van de id-providers die worden gebruikt voor het configureren van App Service-verificatie/-autorisatie.
properties.login	Login	De configuratie-instellingen van de aanmeldingsstroom van gebruikers die App Service-verificatie/-autorisatie gebruiken.
properties.platform	AuthPlatform	De configuratie-instellingen van het platform van App Service-verificatie/-autorisatie.

Antwoorden

Name	Type	Description
200 OK	SiteAuthSettingsV2	OK
Other Status Codes	DefaultErrorResponse	Foutreactie van App Service.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Update Auth Settings V2

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
AllowedAudiencesValidation	De configuratie-instellingen van de validatiestroom Toegestane doelgroepen.
AllowedPrincipals	De configuratie-instellingen van de toegestane principals voor Azure Active Directory.
Apple	De configuratie-instellingen van de Apple-provider.
AppleRegistration	De configuratie-instellingen van de registratie voor de Apple-provider
AppRegistration	De configuratie-instellingen van de app-registratie voor providers die app-id's en app-geheimen hebben
AuthPlatform	De configuratie-instellingen van het platform van App Service-verificatie/-autorisatie.
AzureActiveDirectory	De configuratie-instellingen van de Azure Active Directory-provider.
AzureActiveDirectoryLogin	De configuratie-instellingen van de Azure Active Directory-aanmeldingsstroom.
AzureActiveDirectoryRegistration	De configuratie-instellingen van de registratie van de Azure Active Directory-app.
AzureActiveDirectoryValidation	De configuratie-instellingen van de validatiestroom van het Azure Active Directory-token.
AzureStaticWebApps	De configuratie-instellingen van de Azure Static Web Apps-provider.
AzureStaticWebAppsRegistration	De configuratie-instellingen van de registratie voor de Azure Static Web Apps-provider
BlobStorageTokenStore	De configuratie-instellingen van de opslag van de tokens als blobopslag wordt gebruikt.
ClientCredentialMethod	De methode die moet worden gebruikt om de gebruiker te verifiëren.
ClientRegistration	De configuratie-instellingen van de app-registratie voor providers met client-id's en clientgeheimen
CookieExpiration	De configuratie-instellingen van de verlooptijd van de sessiecooky.
CookieExpirationConvention	De conventie die wordt gebruikt bij het bepalen van de vervaldatum van de sessiecooky.
CustomOpenIdConnectProvider	De configuratie-instellingen van de aangepaste Open ID Connect-provider.
DefaultAuthorizationPolicy	De configuratie-instellingen van het standaardautorisatiebeleid van Azure Active Directory.
DefaultErrorResponse	Foutreactie van App Service.
Details
Error	Foutmodel.
Facebook	De configuratie-instellingen van de Facebook-provider.
FileSystemTokenStore	De configuratie-instellingen van de opslag van de tokens als een bestandssysteem wordt gebruikt.
ForwardProxy	De configuratie-instellingen van een doorstuurproxy die wordt gebruikt om de aanvragen te doen.
ForwardProxyConvention	De conventie die wordt gebruikt om de URL van de aanvraag te bepalen.
GitHub	De configuratie-instellingen van de GitHub-provider.
GlobalValidation	De configuratie-instellingen waarmee de validatiestroom van gebruikers wordt bepaald met behulp van App Service-verificatie/-autorisatie.
Google	De configuratie-instellingen van de Google-provider.
HttpSettings	De configuratie-instellingen van de HTTP-aanvragen voor verificatie- en autorisatieaanvragen die zijn gedaan op basis van App Service-verificatie/-autorisatie.
HttpSettingsRoutes	De configuratie-instellingen van de PADEN HTTP-aanvragen.
IdentityProviders	De configuratie-instellingen van elk van de id-providers die worden gebruikt voor het configureren van App Service-verificatie/-autorisatie.
JwtClaimChecks	De configuratie-instellingen van de controles die moeten worden uitgevoerd tijdens het valideren van de JWT-claims.
LegacyMicrosoftAccount	De configuratie-instellingen van de verouderde Microsoft-accountprovider.
Login	De configuratie-instellingen van de aanmeldingsstroom van gebruikers die App Service-verificatie/-autorisatie gebruiken.
LoginRoutes	De routes die de eindpunten opgeven die worden gebruikt voor aanmeldings- en afmeldingsaanvragen.
LoginScopes	De configuratie-instellingen van de aanmeldingsstroom, inclusief de bereiken die moeten worden aangevraagd.
Nonce	De configuratie-instellingen van de niet-gebruikte in de aanmeldingsstroom.
OpenIdConnectClientCredential	De verificatieclientreferenties van de aangepaste Open ID Connect-provider.
OpenIdConnectConfig	De configuratie-instellingen van de eindpunten die worden gebruikt voor de aangepaste Open ID Connect-provider.
OpenIdConnectLogin	De configuratie-instellingen van de aanmeldingsstroom van de aangepaste Open ID Connect-provider.
OpenIdConnectRegistration	De configuratie-instellingen van de app-registratie voor de aangepaste Open ID Connect-provider.
SiteAuthSettingsV2	Configuratie-instellingen voor de functie Azure App Service-verificatie/autorisatie V2.
TokenStore	De configuratie-instellingen van het tokenarchief.
Twitter	De configuratie-instellingen van de Twitter-provider.
TwitterRegistration	De configuratie-instellingen van de app-registratie voor de Twitter-provider.
UnauthenticatedClientActionV2	De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client probeert toegang te krijgen tot de app.

AllowedAudiencesValidation

Object

De configuratie-instellingen van de validatiestroom Toegestane doelgroepen.

Name	Type	Description
allowedAudiences	string[]	De configuratie-instellingen van de lijst met toegestane doelgroepen waaruit het JWT-token moet worden gevalideerd.

AllowedPrincipals

Object

De configuratie-instellingen van de toegestane principals voor Azure Active Directory.

Name	Type	Description
groups	string[]	De lijst met toegestane groepen.
identities	string[]	De lijst met toegestane identiteiten.

Apple

Object

De configuratie-instellingen van de Apple-provider.

Name	Type	Description
enabled	boolean	false als de Apple-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
login	LoginScopes	De configuratie-instellingen van de aanmeldingsstroom.
registration	AppleRegistration	De configuratie-instellingen van de Apple-registratie.

AppleRegistration

Object

De configuratie-instellingen van de registratie voor de Apple-provider

Name	Type	Description
clientId	string	De client-id van de app die wordt gebruikt voor aanmelding.
clientSecretSettingName	string	De naam van de app-instelling die het clientgeheim bevat.

AppRegistration

Object

De configuratie-instellingen van de app-registratie voor providers die app-id's en app-geheimen hebben

Name	Type	Description
appId	string	De app-id van de app die wordt gebruikt voor aanmelding.
appSecretSettingName	string	De naam van de app-instelling die het app-geheim bevat.

AuthPlatform

Object

De configuratie-instellingen van het platform van App Service-verificatie/-autorisatie.

Name	Type	Description
configFilePath	string	Het pad van het configuratiebestand met verificatie-instellingen als deze afkomstig zijn van een bestand. Als het pad relatief is, wordt de basismap van de site gebruikt.
enabled	boolean	true als de verificatie-/autorisatiefunctie is ingeschakeld voor de huidige app; anders, false.
runtimeVersion	string	De RuntimeVersion van de functie Verificatie/Autorisatie die wordt gebruikt voor de huidige app. De instelling in deze waarde kan het gedrag van bepaalde functies in de module Verificatie/Autorisatie bepalen.

AzureActiveDirectory

Object

De configuratie-instellingen van de Azure Active Directory-provider.

Name	Type	Description
enabled	boolean	false als de Azure Active Directory-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
isAutoProvisioned	boolean	Hiermee wordt een waarde opgehaald die aangeeft of de Azure AD-configuratie automatisch is ingericht met behulp van hulpprogramma's van derden. Dit is een interne vlag die voornamelijk is bedoeld ter ondersteuning van de Azure Management Portal. Gebruikers mogen deze eigenschap niet lezen of schrijven.
login	AzureActiveDirectoryLogin	De configuratie-instellingen van de Azure Active Directory-aanmeldingsstroom.
registration	AzureActiveDirectoryRegistration	De configuratie-instellingen van de registratie van de Azure Active Directory-app.
validation	AzureActiveDirectoryValidation	De configuratie-instellingen van de validatiestroom van het Azure Active Directory-token.

AzureActiveDirectoryLogin

Object

De configuratie-instellingen van de Azure Active Directory-aanmeldingsstroom.

Name	Type	Description
disableWWWAuthenticate	boolean	true als de www-authenticate-provider moet worden weggelaten uit de aanvraag; anders, false.
loginParameters	string[]	Aanmeldingsparameters voor het verzenden naar het OpenID Connect-autorisatie-eindpunt wanneer een gebruiker zich aanmeldt. Elke parameter moet de notatie key=value hebben.

AzureActiveDirectoryRegistration

Object

De configuratie-instellingen van de registratie van de Azure Active Directory-app.

Name	Type	Description
clientId	string	De client-id van deze relying party-toepassing, ook wel de client_id genoemd. Deze instelling is vereist voor het inschakelen van OpenID-verbindingsverificatie met Azure Active Directory of andere OpenID Connect-providers van derden. Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Een alternatief voor de vingerafdruk van het clientgeheim, namelijk de uitgever van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als vervanging voor de vingerafdruk van het clientgeheimcertificaat. Het is ook optioneel.
clientSecretCertificateSubjectAlternativeName	string	Een alternatief voor de vingerafdruk van het clientgeheim, dat is de alternatieve naam van het onderwerp van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als vervanging voor de vingerafdruk van het clientgeheimcertificaat. Het is ook optioneel.
clientSecretCertificateThumbprint	string	Een alternatief voor het clientgeheim, dat is de vingerafdruk van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als vervanging voor het clientgeheim. Het is ook optioneel.
clientSecretSettingName	string	De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat.
openIdIssuer	string	De OpenID Connect Issuer-URI die de entiteit vertegenwoordigt die toegangstokens voor deze toepassing uitgeeft. Wanneer u Azure Active Directory gebruikt, is deze waarde de URI van de directorytenant, bijvoorbeeld https://login.microsoftonline.com/v2.0/{tenant-guid}/. Deze URI is een hoofdlettergevoelige id voor de tokenverlener. Meer informatie over OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Object

De configuratie-instellingen van de validatiestroom van het Azure Active Directory-token.

Name	Type	Description
allowedAudiences	string[]	De lijst met doelgroepen die geslaagde verificatie-/autorisatieaanvragen kunnen indienen.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	De configuratie-instellingen van het standaardautorisatiebeleid.
jwtClaimChecks	JwtClaimChecks	De configuratie-instellingen van de controles die moeten worden uitgevoerd tijdens het valideren van de JWT-claims.

AzureStaticWebApps

Object

De configuratie-instellingen van de Azure Static Web Apps-provider.

Name	Type	Description
enabled	boolean	false als de Azure Static Web Apps-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
registration	AzureStaticWebAppsRegistration	De configuratie-instellingen van de registratie van Azure Static Web Apps.

AzureStaticWebAppsRegistration

Object

De configuratie-instellingen van de registratie voor de Azure Static Web Apps-provider

Name	Type	Description
clientId	string	De client-id van de app die wordt gebruikt voor aanmelding.

BlobStorageTokenStore

Object

De configuratie-instellingen van de opslag van de tokens als blobopslag wordt gebruikt.

Name	Type	Description
sasUrlSettingName	string	De naam van de app-instelling met de SAS-URL van de blobopslag met de tokens.

ClientCredentialMethod

Inventarisatie

De methode die moet worden gebruikt om de gebruiker te verifiëren.

Waarde	Description
ClientSecretPost

ClientRegistration

Object

De configuratie-instellingen van de app-registratie voor providers met client-id's en clientgeheimen

Name	Type	Description
clientId	string	De client-id van de app die wordt gebruikt voor aanmelding.
clientSecretSettingName	string	De naam van de app-instelling die het clientgeheim bevat.

CookieExpiration

Object

De configuratie-instellingen van de verlooptijd van de sessiecooky.

Name	Type	Description
convention	CookieExpirationConvention	De conventie die wordt gebruikt bij het bepalen van de vervaldatum van de sessiecooky.
timeToExpiration	string	De tijd nadat de aanvraag is ingediend wanneer de sessiecookis moet verlopen.

CookieExpirationConvention

Inventarisatie

De conventie die wordt gebruikt bij het bepalen van de vervaldatum van de sessiecooky.

Waarde	Description
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

De configuratie-instellingen van de aangepaste Open ID Connect-provider.

Name	Type	Description
enabled	boolean	false als de aangepaste Open ID-providerprovider niet mag worden ingeschakeld; anders, true.
login	OpenIdConnectLogin	De configuratie-instellingen van de aanmeldingsstroom van de aangepaste Open ID Connect-provider.
registration	OpenIdConnectRegistration	De configuratie-instellingen van de app-registratie voor de aangepaste Open ID Connect-provider.

DefaultAuthorizationPolicy

Object

De configuratie-instellingen van het standaardautorisatiebeleid van Azure Active Directory.

Name	Type	Description
allowedApplications	string[]	De configuratie-instellingen van de door Azure Active Directory toegestane toepassingen.
allowedPrincipals	AllowedPrincipals	De configuratie-instellingen van de toegestane principals voor Azure Active Directory.

DefaultErrorResponse

Object

Foutreactie van App Service.

Name	Type	Description
error	Error	Foutmodel.

Details

Object

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

Error

Object

Foutmodel.

Name	Type	Description
code	string	Gestandaardiseerde tekenreeks om de fout programmatisch te identificeren.
details	Details[]	Gedetailleerde fouten.
innererror	string	Meer informatie over foutopsporing.
message	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.
target	string	Gedetailleerde foutbeschrijving en foutopsporingsgegevens.

Facebook

Object

De configuratie-instellingen van de Facebook-provider.

Name	Type	Description
enabled	boolean	false als de Facebook-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
graphApiVersion	string	De versie van de Facebook-API die moet worden gebruikt tijdens het aanmelden.
login	LoginScopes	De configuratie-instellingen van de aanmeldingsstroom.
registration	AppRegistration	De configuratie-instellingen van de app-registratie voor de Facebook-provider.

FileSystemTokenStore

Object

De configuratie-instellingen van de opslag van de tokens als een bestandssysteem wordt gebruikt.

Name	Type	Description
directory	string	De map waarin de tokens worden opgeslagen.

ForwardProxy

Object

De configuratie-instellingen van een doorstuurproxy die wordt gebruikt om de aanvragen te doen.

Name	Type	Description
convention	ForwardProxyConvention	De conventie die wordt gebruikt om de URL van de aanvraag te bepalen.
customHostHeaderName	string	De naam van de header die de host van de aanvraag bevat.
customProtoHeaderName	string	De naam van de header die het schema van de aanvraag bevat.

ForwardProxyConvention

Inventarisatie

De conventie die wordt gebruikt om de URL van de aanvraag te bepalen.

Waarde	Description
Custom
NoProxy
Standard

GitHub

Object

De configuratie-instellingen van de GitHub-provider.

Name	Type	Description
enabled	boolean	false als de GitHub-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
login	LoginScopes	De configuratie-instellingen van de aanmeldingsstroom.
registration	ClientRegistration	De configuratie-instellingen van de app-registratie voor de GitHub-provider.

GlobalValidation

Object

De configuratie-instellingen waarmee de validatiestroom van gebruikers wordt bepaald met behulp van App Service-verificatie/-autorisatie.

Name	Type	Description
excludedPaths	string[]	De paden waarvoor niet-geverifieerde stroom niet wordt omgeleid naar de aanmeldingspagina.
redirectToProvider	string	De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd. Deze instelling is alleen nodig als meerdere providers zijn geconfigureerd en de niet-geverifieerde clientactie is ingesteld op RedirectToLoginPage.
requireAuthentication	boolean	true als voor de verificatiestroom een aanvraag is vereist; anders, false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client probeert toegang te krijgen tot de app.

Google

Object

De configuratie-instellingen van de Google-provider.

Name	Type	Description
enabled	boolean	false als de Google-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
login	LoginScopes	De configuratie-instellingen van de aanmeldingsstroom.
registration	ClientRegistration	De configuratie-instellingen van de app-registratie voor de Google-provider.
validation	AllowedAudiencesValidation	De configuratie-instellingen van de validatiestroom van het Azure Active Directory-token.

HttpSettings

Object

De configuratie-instellingen van de HTTP-aanvragen voor verificatie- en autorisatieaanvragen die zijn gedaan op basis van App Service-verificatie/-autorisatie.

Name	Type	Description
forwardProxy	ForwardProxy	De configuratie-instellingen van een doorstuurproxy die wordt gebruikt om de aanvragen te doen.
requireHttps	boolean	false als de verificatie-/autorisatiereacties die niet over het HTTPS-schema beschikken, zijn toegestaan; anders, true.
routes	HttpSettingsRoutes	De configuratie-instellingen van de PADEN HTTP-aanvragen.

HttpSettingsRoutes

Object

De configuratie-instellingen van de PADEN HTTP-aanvragen.

Name	Type	Description
apiPrefix	string	Het voorvoegsel dat moet voorafgaan aan alle verificatie-/autorisatiepaden.

IdentityProviders

Object

De configuratie-instellingen van elk van de id-providers die worden gebruikt voor het configureren van App Service-verificatie/-autorisatie.

Name	Type	Description
apple	Apple	De configuratie-instellingen van de Apple-provider.
azureActiveDirectory	AzureActiveDirectory	De configuratie-instellingen van de Azure Active Directory-provider.
azureStaticWebApps	AzureStaticWebApps	De configuratie-instellingen van de Azure Static Web Apps-provider.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	De kaart van de naam van de alias van elke aangepaste Open ID Connect-provider met de configuratie-instellingen van de aangepaste Open ID Connect-provider.
facebook	Facebook	De configuratie-instellingen van de Facebook-provider.
gitHub	GitHub	De configuratie-instellingen van de GitHub-provider.
google	Google	De configuratie-instellingen van de Google-provider.
legacyMicrosoftAccount	LegacyMicrosoftAccount	De configuratie-instellingen van de verouderde Microsoft-accountprovider.
twitter	Twitter	De configuratie-instellingen van de Twitter-provider.

JwtClaimChecks

Object

De configuratie-instellingen van de controles die moeten worden uitgevoerd tijdens het valideren van de JWT-claims.

Name	Type	Description
allowedClientApplications	string[]	De lijst met toegestane clienttoepassingen.
allowedGroups	string[]	De lijst met toegestane groepen.

LegacyMicrosoftAccount

Object

De configuratie-instellingen van de verouderde Microsoft-accountprovider.

Name	Type	Description
enabled	boolean	false als de verouderde Microsoft-accountprovider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
login	LoginScopes	De configuratie-instellingen van de aanmeldingsstroom.
registration	ClientRegistration	De configuratie-instellingen van de app-registratie voor de verouderde Microsoft-accountprovider.
validation	AllowedAudiencesValidation	De configuratie-instellingen van de verouderde validatiestroom van de Microsoft-accountprovider.

Login

Object

De configuratie-instellingen van de aanmeldingsstroom van gebruikers die App Service-verificatie/-autorisatie gebruiken.

Name	Type	Description
allowedExternalRedirectUrls	string[]	Externe URL's waarnaar kan worden omgeleid als onderdeel van het aanmelden of afmelden bij de app. Houd er rekening mee dat het querytekenreeksgedeelte van de URL wordt genegeerd. Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen. Houd er rekening mee dat URL's binnen het huidige domein altijd impliciet zijn toegestaan.
cookieExpiration	CookieExpiration	De configuratie-instellingen van de verlooptijd van de sessiecooky.
nonce	Nonce	De configuratie-instellingen van de niet-gebruikte in de aanmeldingsstroom.
preserveUrlFragmentsForLogins	boolean	true als de fragmenten van de aanvraag behouden blijven nadat de aanmeldingsaanvraag is ingediend; anders, false.
routes	LoginRoutes	De routes die de eindpunten opgeven die worden gebruikt voor aanmeldings- en afmeldingsaanvragen.
tokenStore	TokenStore	De configuratie-instellingen van het tokenarchief.

LoginRoutes

Object

De routes die de eindpunten opgeven die worden gebruikt voor aanmeldings- en afmeldingsaanvragen.

Name	Type	Description
logoutEndpoint	string	Het eindpunt waarop een afmeldingsaanvraag moet worden ingediend.

LoginScopes

Object

De configuratie-instellingen van de aanmeldingsstroom, inclusief de bereiken die moeten worden aangevraagd.

Name	Type	Description
scopes	string[]	Een lijst met de bereiken die moeten worden aangevraagd tijdens de verificatie.

Nonce

Object

De configuratie-instellingen van de niet-gebruikte in de aanmeldingsstroom.

Name	Type	Description
nonceExpirationInterval	string	De tijd na het indienen van de aanvraag wanneer de nonce moet verlopen.
validateNonce	boolean	false als de nonce niet moet worden gevalideerd tijdens het voltooien van de aanmeldingsstroom; anders, true.

OpenIdConnectClientCredential

Object

De verificatieclientreferenties van de aangepaste Open ID Connect-provider.

Name	Type	Description
clientSecretSettingName	string	De app-instelling die het clientgeheim voor de aangepaste Open ID Connect-provider bevat.
method	ClientCredentialMethod	De methode die moet worden gebruikt om de gebruiker te verifiëren.

OpenIdConnectConfig

Object

De configuratie-instellingen van de eindpunten die worden gebruikt voor de aangepaste Open ID Connect-provider.

Name	Type	Description
authorizationEndpoint	string	Het eindpunt dat moet worden gebruikt voor het indienen van een autorisatieaanvraag.
certificationUri	string	Het eindpunt dat de sleutels levert die nodig zijn om het token te valideren.
issuer	string	Het eindpunt dat het token uitgeeft.
tokenEndpoint	string	Het eindpunt dat moet worden gebruikt om een token aan te vragen.
wellKnownOpenIdConfiguration	string	Het eindpunt dat alle configuratie-eindpunten voor de provider bevat.

OpenIdConnectLogin

Object

De configuratie-instellingen van de aanmeldingsstroom van de aangepaste Open ID Connect-provider.

Name	Type	Description
nameClaimType	string	De naam van de claim die de gebruikersnaam bevat.
scopes	string[]	Een lijst met de bereiken die moeten worden aangevraagd tijdens de verificatie.

OpenIdConnectRegistration

Object

De configuratie-instellingen van de app-registratie voor de aangepaste Open ID Connect-provider.

Name	Type	Description
clientCredential	OpenIdConnectClientCredential	De verificatiereferenties van de aangepaste Open ID Connect-provider.
clientId	string	De client-id van de aangepaste Open ID Connect-provider.
openIdConnectConfiguration	OpenIdConnectConfig	De configuratie-instellingen van de eindpunten die worden gebruikt voor de aangepaste Open ID Connect-provider.

SiteAuthSettingsV2

Object

Configuratie-instellingen voor de functie Azure App Service-verificatie/autorisatie V2.

Name	Type	Description
id	string	Resource-id.
kind	string	Soort resource.
name	string	Resourcenaam.
properties.globalValidation	GlobalValidation	De configuratie-instellingen waarmee de validatiestroom van gebruikers wordt bepaald met behulp van App Service-verificatie/-autorisatie.
properties.httpSettings	HttpSettings	De configuratie-instellingen van de HTTP-aanvragen voor verificatie- en autorisatieaanvragen die zijn gedaan op basis van App Service-verificatie/-autorisatie.
properties.identityProviders	IdentityProviders	De configuratie-instellingen van elk van de id-providers die worden gebruikt voor het configureren van App Service-verificatie/-autorisatie.
properties.login	Login	De configuratie-instellingen van de aanmeldingsstroom van gebruikers die App Service-verificatie/-autorisatie gebruiken.
properties.platform	AuthPlatform	De configuratie-instellingen van het platform van App Service-verificatie/-autorisatie.
type	string	Resourcetype.

TokenStore

Object

De configuratie-instellingen van het tokenarchief.

Name	Type	Description
azureBlobStorage	BlobStorageTokenStore	De configuratie-instellingen van de opslag van de tokens als blobopslag wordt gebruikt.
enabled	boolean	true voor het duurzaam opslaan van platformspecifieke beveiligingstokens die worden verkregen tijdens aanmeldingsstromen; anders, false. De standaardwaarde is false.
fileSystem	FileSystemTokenStore	De configuratie-instellingen van de opslag van de tokens als een bestandssysteem wordt gebruikt.
tokenRefreshExtensionHours	number (double)	Het aantal uren na het verlopen van het sessietoken dat een sessietoken kan worden gebruikt om de API voor het vernieuwen van tokens aan te roepen. De standaardwaarde is 72 uur.

Twitter

Object

De configuratie-instellingen van de Twitter-provider.

Name	Type	Description
enabled	boolean	false als de Twitter-provider niet mag worden ingeschakeld ondanks de ingestelde registratie; anders, true.
registration	TwitterRegistration	De configuratie-instellingen van de app-registratie voor de Twitter-provider.

TwitterRegistration

Object

De configuratie-instellingen van de app-registratie voor de Twitter-provider.

Name	Type	Description
consumerKey	string	De OAuth 1.0a-consumentensleutel van de Twitter-toepassing die wordt gebruikt voor aanmelding. Deze instelling is vereist voor het inschakelen van Twitter-aanmelding. Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	De naam van de app-instelling die het OAuth 1.0a-consumentengeheim bevat van de Twitter-toepassing die wordt gebruikt voor aanmelding.

UnauthenticatedClientActionV2

Inventarisatie

De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client probeert toegang te krijgen tot de app.

Waarde	Description
AllowAnonymous
RedirectToLoginPage
Return401
Return403