Web Apps - Update Auth Settings V2

Tjänst:

App Service

API-version:

2024-04-01

Beskrivning av autentiserings-/auktoriseringsinställningar för appar via V2-format

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
name	path	True	string	Namnet på webbappen.
resourceGroupName	path	True	string	Namnet på resursgruppen som resursen tillhör. Reguljärt uttrycksmönster: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Ditt Azure-prenumerations-ID. Det här är en GUID-formaterad sträng (t.ex. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-version

Begärandetext

Name	Typ	Description
kind	string	Typ av resurs.
properties.globalValidation	GlobalValidation	Konfigurationsinställningarna som avgör valideringsflödet för användare med apptjänstautentisering/auktorisering.
properties.httpSettings	HttpSettings	Konfigurationsinställningarna för HTTP-begäranden för autentisering och auktoriseringsbegäranden som görs mot App Service-autentisering/auktorisering.
properties.identityProviders	IdentityProviders	Konfigurationsinställningarna för var och en av de identitetsprovidrar som används för att konfigurera App Service-autentisering/auktorisering.
properties.login	Login	Konfigurationsinställningarna för inloggningsflödet för användare som använder App Service-autentisering/auktorisering.
properties.platform	AuthPlatform	Konfigurationsinställningarna för plattformen för App Service-autentisering/auktorisering.

Svar

Name	Typ	Description
200 OK	SiteAuthSettingsV2	OKEJ
Other Status Codes	DefaultErrorResponse	App Service-felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Update Auth Settings V2

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Definitioner

Name	Description
AllowedAudiencesValidation	Konfigurationsinställningarna för valideringsflödet Tillåtna målgrupper.
AllowedPrincipals	Konfigurationsinställningarna för azure Active Directory-tillåtna huvudnamn.
Apple	Konfigurationsinställningarna för Apple-providern.
AppleRegistration	Konfigurationsinställningarna för registreringen för Apple-providern
AppRegistration	Konfigurationsinställningarna för appregistreringen för leverantörer som har app-ID:er och apphemligheter
AuthPlatform	Konfigurationsinställningarna för plattformen för App Service-autentisering/auktorisering.
AzureActiveDirectory	Konfigurationsinställningarna för Azure Active Directory-providern.
AzureActiveDirectoryLogin	Konfigurationsinställningarna för Azure Active Directory-inloggningsflödet.
AzureActiveDirectoryRegistration	Konfigurationsinställningarna för Azure Active Directory-appregistreringen.
AzureActiveDirectoryValidation	Konfigurationsinställningarna för valideringsflödet för Azure Active Directory-token.
AzureStaticWebApps	Konfigurationsinställningarna för Azure Static Web Apps-providern.
AzureStaticWebAppsRegistration	Konfigurationsinställningarna för registreringen för Azure Static Web Apps-providern
BlobStorageTokenStore	Konfigurationsinställningarna för lagring av token om bloblagring används.
ClientCredentialMethod	Den metod som ska användas för att autentisera användaren.
ClientRegistration	Konfigurationsinställningarna för appregistreringen för leverantörer som har klient-ID och klienthemligheter
CookieExpiration	Konfigurationsinställningarna för sessionscookiens upphörande.
CookieExpirationConvention	Konventionen som används när sessionscookien upphör att gälla.
CustomOpenIdConnectProvider	Konfigurationsinställningarna för den anpassade Open ID Connect-providern.
DefaultAuthorizationPolicy	Konfigurationsinställningarna för Azure Active Directory-standardauktoriseringsprincipen.
DefaultErrorResponse	App Service-felsvar.
Details
Error	Felmodell.
Facebook	Konfigurationsinställningarna för Facebook-providern.
FileSystemTokenStore	Konfigurationsinställningarna för lagringen av token om ett filsystem används.
ForwardProxy	Konfigurationsinställningarna för en vidarebefordranproxy som används för att göra begäranden.
ForwardProxyConvention	Den konvention som används för att fastställa url:en för den begäran som gjorts.
GitHub	Konfigurationsinställningarna för GitHub-providern.
GlobalValidation	Konfigurationsinställningarna som avgör valideringsflödet för användare med apptjänstautentisering/auktorisering.
Google	Konfigurationsinställningarna för Google-providern.
HttpSettings	Konfigurationsinställningarna för HTTP-begäranden för autentisering och auktoriseringsbegäranden som görs mot App Service-autentisering/auktorisering.
HttpSettingsRoutes	Konfigurationsinställningarna för sökvägarna HTTP-begäranden.
IdentityProviders	Konfigurationsinställningarna för var och en av de identitetsprovidrar som används för att konfigurera App Service-autentisering/auktorisering.
JwtClaimChecks	Konfigurationsinställningarna för de kontroller som ska göras när JWT-anspråken verifieras.
LegacyMicrosoftAccount	Konfigurationsinställningarna för den äldre Microsoft-kontoleverantören.
Login	Konfigurationsinställningarna för inloggningsflödet för användare som använder App Service-autentisering/auktorisering.
LoginRoutes	De vägar som anger de slutpunkter som används för inloggnings- och utloggningsbegäranden.
LoginScopes	Konfigurationsinställningarna för inloggningsflödet, inklusive de omfång som ska begäras.
Nonce	Konfigurationsinställningarna för nonce som används i inloggningsflödet.
OpenIdConnectClientCredential	Autentiseringsklientens autentiseringsuppgifter för den anpassade Open ID Connect-providern.
OpenIdConnectConfig	Konfigurationsinställningarna för de slutpunkter som används för den anpassade Open ID Connect-providern.
OpenIdConnectLogin	Konfigurationsinställningarna för inloggningsflödet för den anpassade Open ID Connect-providern.
OpenIdConnectRegistration	Konfigurationsinställningarna för appregistreringen för den anpassade Open ID Connect-providern.
SiteAuthSettingsV2	Konfigurationsinställningar för funktionen Azure App Service Authentication/Authorization V2.
TokenStore	Konfigurationsinställningarna för tokenarkivet.
Twitter	Konfigurationsinställningarna för Twitter-providern.
TwitterRegistration	Konfigurationsinställningarna för appregistreringen för Twitter-providern.
UnauthenticatedClientActionV2	Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.

AllowedAudiencesValidation

Object

Konfigurationsinställningarna för valideringsflödet Tillåtna målgrupper.

Name	Typ	Description
allowedAudiences	string[]	Konfigurationsinställningarna för den tillåtna listan över målgrupper som JWT-token ska verifieras från.

AllowedPrincipals

Object

Konfigurationsinställningarna för azure Active Directory-tillåtna huvudnamn.

Name	Typ	Description
groups	string[]	Listan över tillåtna grupper.
identities	string[]	Listan över tillåtna identiteter.

Apple

Object

Konfigurationsinställningarna för Apple-providern.

Name	Typ	Description
enabled	boolean	false om Apple-providern inte ska aktiveras trots den angivna registreringen. annars true.
login	LoginScopes	Konfigurationsinställningarna för inloggningsflödet.
registration	AppleRegistration	Konfigurationsinställningarna för Apple-registreringen.

AppleRegistration

Object

Konfigurationsinställningarna för registreringen för Apple-providern

Name	Typ	Description
clientId	string	Klient-ID för appen som används för inloggning.
clientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten.

AppRegistration

Object

Konfigurationsinställningarna för appregistreringen för leverantörer som har app-ID:er och apphemligheter

Name	Typ	Description
appId	string	App-ID för den app som används för inloggning.
appSecretSettingName	string	Namnet på appinställningen som innehåller apphemligheten.

AuthPlatform

Object

Konfigurationsinställningarna för plattformen för App Service-autentisering/auktorisering.

Name	Typ	Description
configFilePath	string	Sökvägen till konfigurationsfilen som innehåller autentiseringsinställningar om de kommer från en fil. Om sökvägen är relativ kommer platsens rotkatalog att vara basen.
enabled	boolean	true om funktionen Autentisering/auktorisering är aktiverad för den aktuella appen. annars false.
runtimeVersion	string	RuntimeVersion för funktionen Autentisering/auktorisering som används för den aktuella appen. Inställningen i det här värdet kan styra beteendet för vissa funktioner i modulen Autentisering/auktorisering.

AzureActiveDirectory

Object

Konfigurationsinställningarna för Azure Active Directory-providern.

Name	Typ	Description
enabled	boolean	false om Azure Active Directory-providern inte ska aktiveras trots den angivna registreringen. annars true.
isAutoProvisioned	boolean	Hämtar ett värde som anger om Azure AD-konfigurationen har etablerats automatiskt med hjälp av verktyg från första part. Det här är en intern flagga som främst är avsedd att stödja Azure-hanteringsportalen. Användare bör inte läsa eller skriva till den här egenskapen.
login	AzureActiveDirectoryLogin	Konfigurationsinställningarna för Azure Active Directory-inloggningsflödet.
registration	AzureActiveDirectoryRegistration	Konfigurationsinställningarna för Azure Active Directory-appregistreringen.
validation	AzureActiveDirectoryValidation	Konfigurationsinställningarna för valideringsflödet för Azure Active Directory-token.

AzureActiveDirectoryLogin

Object

Konfigurationsinställningarna för Azure Active Directory-inloggningsflödet.

Name	Typ	Description
disableWWWAuthenticate	boolean	true om den www-autentiserande leverantören bör utelämnas från begäran. annars false.
loginParameters	string[]	Inloggningsparametrar som ska skickas till OpenID Connect-auktoriseringsslutpunkten när en användare loggar in. Varje parameter måste vara i formatet "key=value".

AzureActiveDirectoryRegistration

Object

Konfigurationsinställningarna för Azure Active Directory-appregistreringen.

Name	Typ	Description
clientId	string	Klient-ID:t för det här förlitande partprogrammet, som kallas client_id. Den här inställningen krävs för att aktivera OpenID-anslutningsautentisering med Azure Active Directory eller andra OpenID Connect-leverantörer från tredje part. Mer information om OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Ett alternativ till det klienthemliga tumavtrycket, som är utfärdaren av ett certifikat som används i signeringssyfte. Den här egenskapen fungerar som en ersättning för tumavtrycket för klienthemlighetscertifikatet. Det är också valfritt.
clientSecretCertificateSubjectAlternativeName	string	Ett alternativ till det klienthemliga tumavtrycket, som är det alternativa namnet på ett certifikat som används för signering. Den här egenskapen fungerar som en ersättning för tumavtrycket för klienthemlighetscertifikatet. Det är också valfritt.
clientSecretCertificateThumbprint	string	Ett alternativ till klienthemligheten, som är tumavtrycket för ett certifikat som används i signeringssyfte. Den här egenskapen fungerar som en ersättning för klienthemligheten. Det är också valfritt.
clientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten för det förlitande partprogrammet.
openIdIssuer	string	OpenID Connect Issuer-URI:n som representerar entiteten som utfärdar åtkomsttoken för det här programmet. När du använder Azure Active Directory är det här värdet URI för katalogklientorganisationen, t.ex. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Den här URI:n är en skiftlägeskänslig identifierare för token utfärdaren. Mer information om OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Object

Konfigurationsinställningarna för valideringsflödet för Azure Active Directory-token.

Name	Typ	Description
allowedAudiences	string[]	Listan över målgrupper som kan göra lyckade autentiserings-/auktoriseringsbegäranden.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Konfigurationsinställningarna för standardauktoriseringsprincipen.
jwtClaimChecks	JwtClaimChecks	Konfigurationsinställningarna för de kontroller som ska göras när JWT-anspråken verifieras.

AzureStaticWebApps

Object

Konfigurationsinställningarna för Azure Static Web Apps-providern.

Name	Typ	Description
enabled	boolean	false om Azure Static Web Apps-providern inte ska aktiveras trots den angivna registreringen. annars true.
registration	AzureStaticWebAppsRegistration	Konfigurationsinställningarna för Azure Static Web Apps-registreringen.

AzureStaticWebAppsRegistration

Object

Konfigurationsinställningarna för registreringen för Azure Static Web Apps-providern

Name	Typ	Description
clientId	string	Klient-ID för appen som används för inloggning.

BlobStorageTokenStore

Object

Konfigurationsinställningarna för lagring av token om bloblagring används.

Name	Typ	Description
sasUrlSettingName	string	Namnet på appinställningen som innehåller SAS-URL:en för bloblagringen som innehåller token.

ClientCredentialMethod

Enumeration

Den metod som ska användas för att autentisera användaren.

Värde	Description
ClientSecretPost

ClientRegistration

Object

Konfigurationsinställningarna för appregistreringen för leverantörer som har klient-ID och klienthemligheter

Name	Typ	Description
clientId	string	Klient-ID för appen som används för inloggning.
clientSecretSettingName	string	Namnet på appinställningen som innehåller klienthemligheten.

CookieExpiration

Object

Konfigurationsinställningarna för sessionscookiens upphörande.

Name	Typ	Description
convention	CookieExpirationConvention	Konventionen som används när sessionscookien upphör att gälla.
timeToExpiration	string	Tiden efter att begäran görs när sessionscookien ska upphöra att gälla.

CookieExpirationConvention

Enumeration

Konventionen som används när sessionscookien upphör att gälla.

Värde	Description
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

Konfigurationsinställningarna för den anpassade Open ID Connect-providern.

Name	Typ	Description
enabled	boolean	false om den anpassade providern för öppna ID inte ska vara aktiverad. annars true.
login	OpenIdConnectLogin	Konfigurationsinställningarna för inloggningsflödet för den anpassade Open ID Connect-providern.
registration	OpenIdConnectRegistration	Konfigurationsinställningarna för appregistreringen för den anpassade Open ID Connect-providern.

DefaultAuthorizationPolicy

Object

Konfigurationsinställningarna för Azure Active Directory-standardauktoriseringsprincipen.

Name	Typ	Description
allowedApplications	string[]	Konfigurationsinställningarna för tillåtna Azure Active Directory-program.
allowedPrincipals	AllowedPrincipals	Konfigurationsinställningarna för azure Active Directory-tillåtna huvudnamn.

DefaultErrorResponse

Object

App Service-felsvar.

Name	Typ	Description
error	Error	Felmodell.

Details

Object

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Error

Object

Felmodell.

Name	Typ	Description
code	string	Standardiserad sträng för att programmatiskt identifiera felet.
details	Details[]	Detaljerade fel.
innererror	string	Mer information om felsökningsfel.
message	string	Detaljerad felbeskrivning och felsökningsinformation.
target	string	Detaljerad felbeskrivning och felsökningsinformation.

Facebook

Object

Konfigurationsinställningarna för Facebook-providern.

Name	Typ	Description
enabled	boolean	false om Facebook-providern inte ska aktiveras trots den angivna registreringen; annars true.
graphApiVersion	string	Den version av Facebook-API:et som ska användas när du loggar in.
login	LoginScopes	Konfigurationsinställningarna för inloggningsflödet.
registration	AppRegistration	Konfigurationsinställningarna för appregistreringen för Facebook-providern.

FileSystemTokenStore

Object

Konfigurationsinställningarna för lagringen av token om ett filsystem används.

Name	Typ	Description
directory	string	Katalogen där token ska lagras.

ForwardProxy

Object

Konfigurationsinställningarna för en vidarebefordranproxy som används för att göra begäranden.

Name	Typ	Description
convention	ForwardProxyConvention	Den konvention som används för att fastställa url:en för den begäran som gjorts.
customHostHeaderName	string	Namnet på rubriken som innehåller värden för begäran.
customProtoHeaderName	string	Namnet på rubriken som innehåller schemat för begäran.

ForwardProxyConvention

Enumeration

Den konvention som används för att fastställa url:en för den begäran som gjorts.

Värde	Description
Custom
NoProxy
Standard

GitHub

Object

Konfigurationsinställningarna för GitHub-providern.

Name	Typ	Description
enabled	boolean	false om GitHub-providern inte ska aktiveras trots den angivna registreringen. annars true.
login	LoginScopes	Konfigurationsinställningarna för inloggningsflödet.
registration	ClientRegistration	Konfigurationsinställningarna för appregistreringen för GitHub-providern.

GlobalValidation

Object

Konfigurationsinställningarna som avgör valideringsflödet för användare med apptjänstautentisering/auktorisering.

Name	Typ	Description
excludedPaths	string[]	Sökvägarna för vilka oautentiserade flöde inte omdirigeras till inloggningssidan.
redirectToProvider	string	Standardautentiseringsprovidern som ska användas när flera leverantörer konfigureras. Den här inställningen behövs bara om flera leverantörer har konfigurerats och den oautentiserade klientåtgärden är inställd på "RedirectToLoginPage".
requireAuthentication	boolean	true om autentiseringsflödet krävs görs en begäran. annars false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.

Google

Object

Konfigurationsinställningarna för Google-providern.

Name	Typ	Description
enabled	boolean	false om Google-providern inte ska aktiveras trots den angivna registreringen. annars true.
login	LoginScopes	Konfigurationsinställningarna för inloggningsflödet.
registration	ClientRegistration	Konfigurationsinställningarna för appregistreringen för Google-providern.
validation	AllowedAudiencesValidation	Konfigurationsinställningarna för valideringsflödet för Azure Active Directory-token.

HttpSettings

Object

Konfigurationsinställningarna för HTTP-begäranden för autentisering och auktoriseringsbegäranden som görs mot App Service-autentisering/auktorisering.

Name	Typ	Description
forwardProxy	ForwardProxy	Konfigurationsinställningarna för en vidarebefordranproxy som används för att göra begäranden.
requireHttps	boolean	false om autentiserings-/auktoriseringssvar som inte har HTTPS-schemat är tillåtna; annars true.
routes	HttpSettingsRoutes	Konfigurationsinställningarna för sökvägarna HTTP-begäranden.

HttpSettingsRoutes

Object

Konfigurationsinställningarna för sökvägarna HTTP-begäranden.

Name	Typ	Description
apiPrefix	string	Prefixet som ska föregå alla autentiserings-/auktoriseringssökvägar.

IdentityProviders

Object

Konfigurationsinställningarna för var och en av de identitetsprovidrar som används för att konfigurera App Service-autentisering/auktorisering.

Name	Typ	Description
apple	Apple	Konfigurationsinställningarna för Apple-providern.
azureActiveDirectory	AzureActiveDirectory	Konfigurationsinställningarna för Azure Active Directory-providern.
azureStaticWebApps	AzureStaticWebApps	Konfigurationsinställningarna för Azure Static Web Apps-providern.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Kartan över namnet på aliaset för varje anpassad Open ID Connect-provider till konfigurationsinställningarna för den anpassade Open ID Connect-providern.
facebook	Facebook	Konfigurationsinställningarna för Facebook-providern.
gitHub	GitHub	Konfigurationsinställningarna för GitHub-providern.
google	Google	Konfigurationsinställningarna för Google-providern.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Konfigurationsinställningarna för den äldre Microsoft-kontoleverantören.
twitter	Twitter	Konfigurationsinställningarna för Twitter-providern.

JwtClaimChecks

Object

Konfigurationsinställningarna för de kontroller som ska göras när JWT-anspråken verifieras.

Name	Typ	Description
allowedClientApplications	string[]	Listan över tillåtna klientprogram.
allowedGroups	string[]	Listan över tillåtna grupper.

LegacyMicrosoftAccount

Object

Konfigurationsinställningarna för den äldre Microsoft-kontoleverantören.

Name	Typ	Description
enabled	boolean	false om den äldre Microsoft-kontoleverantören inte ska aktiveras trots den angivna registreringen. annars true.
login	LoginScopes	Konfigurationsinställningarna för inloggningsflödet.
registration	ClientRegistration	Konfigurationsinställningarna för appregistreringen för den äldre Microsoft-kontoleverantören.
validation	AllowedAudiencesValidation	Konfigurationsinställningarna för det äldre valideringsflödet för Microsoft-kontoproviderns token.

Login

Object

Konfigurationsinställningarna för inloggningsflödet för användare som använder App Service-autentisering/auktorisering.

Name	Typ	Description
allowedExternalRedirectUrls	string[]	Externa URL:er som kan omdirigeras till som en del av att logga in eller logga ut från appen. Observera att frågesträngens del av URL:en ignoreras. Det här är en avancerad inställning som vanligtvis bara behövs av Windows Store-programservrar. Observera att URL:er inom den aktuella domänen alltid är implicit tillåtna.
cookieExpiration	CookieExpiration	Konfigurationsinställningarna för sessionscookiens upphörande.
nonce	Nonce	Konfigurationsinställningarna för nonce som används i inloggningsflödet.
preserveUrlFragmentsForLogins	boolean	true om fragmenten från begäran bevaras efter att inloggningsbegäran har gjorts. annars false.
routes	LoginRoutes	De vägar som anger de slutpunkter som används för inloggnings- och utloggningsbegäranden.
tokenStore	TokenStore	Konfigurationsinställningarna för tokenarkivet.

LoginRoutes

Object

De vägar som anger de slutpunkter som används för inloggnings- och utloggningsbegäranden.

Name	Typ	Description
logoutEndpoint	string	Slutpunkten där en utloggningsbegäran ska göras.

LoginScopes

Object

Konfigurationsinställningarna för inloggningsflödet, inklusive de omfång som ska begäras.

Name	Typ	Description
scopes	string[]	En lista över de omfång som ska begäras vid autentisering.

Nonce

Object

Konfigurationsinställningarna för nonce som används i inloggningsflödet.

Name	Typ	Description
nonceExpirationInterval	string	Tiden efter att begäran görs när nonce ska upphöra att gälla.
validateNonce	boolean	false om nonce inte ska valideras när inloggningsflödet slutförs. annars true.

OpenIdConnectClientCredential

Object

Autentiseringsklientens autentiseringsuppgifter för den anpassade Open ID Connect-providern.

Name	Typ	Description
clientSecretSettingName	string	Appinställningen som innehåller klienthemligheten för den anpassade Open ID Connect-providern.
method	ClientCredentialMethod	Den metod som ska användas för att autentisera användaren.

OpenIdConnectConfig

Object

Konfigurationsinställningarna för de slutpunkter som används för den anpassade Open ID Connect-providern.

Name	Typ	Description
authorizationEndpoint	string	Slutpunkten som ska användas för att göra en auktoriseringsbegäran.
certificationUri	string	Slutpunkten som tillhandahåller de nycklar som krävs för att verifiera token.
issuer	string	Slutpunkten som utfärdar token.
tokenEndpoint	string	Slutpunkten som ska användas för att begära en token.
wellKnownOpenIdConfiguration	string	Slutpunkten som innehåller alla konfigurationsslutpunkter för providern.

OpenIdConnectLogin

Object

Konfigurationsinställningarna för inloggningsflödet för den anpassade Open ID Connect-providern.

Name	Typ	Description
nameClaimType	string	Namnet på anspråket som innehåller användarnas namn.
scopes	string[]	En lista över de omfång som ska begäras vid autentisering.

OpenIdConnectRegistration

Object

Konfigurationsinställningarna för appregistreringen för den anpassade Open ID Connect-providern.

Name	Typ	Description
clientCredential	OpenIdConnectClientCredential	Autentiseringsuppgifterna för den anpassade Open ID Connect-providern.
clientId	string	Klient-ID för den anpassade Open ID Connect-providern.
openIdConnectConfiguration	OpenIdConnectConfig	Konfigurationsinställningarna för de slutpunkter som används för den anpassade Open ID Connect-providern.

SiteAuthSettingsV2

Object

Konfigurationsinställningar för funktionen Azure App Service Authentication/Authorization V2.

Name	Typ	Description
id	string	Resurs-ID.
kind	string	Typ av resurs.
name	string	Resursnamn.
properties.globalValidation	GlobalValidation	Konfigurationsinställningarna som avgör valideringsflödet för användare med apptjänstautentisering/auktorisering.
properties.httpSettings	HttpSettings	Konfigurationsinställningarna för HTTP-begäranden för autentisering och auktoriseringsbegäranden som görs mot App Service-autentisering/auktorisering.
properties.identityProviders	IdentityProviders	Konfigurationsinställningarna för var och en av de identitetsprovidrar som används för att konfigurera App Service-autentisering/auktorisering.
properties.login	Login	Konfigurationsinställningarna för inloggningsflödet för användare som använder App Service-autentisering/auktorisering.
properties.platform	AuthPlatform	Konfigurationsinställningarna för plattformen för App Service-autentisering/auktorisering.
type	string	Resurstyp.

TokenStore

Object

Konfigurationsinställningarna för tokenarkivet.

Name	Typ	Description
azureBlobStorage	BlobStorageTokenStore	Konfigurationsinställningarna för lagring av token om bloblagring används.
enabled	boolean	true att lagra plattformsspecifika säkerhetstoken som hämtas under inloggningsflöden. annars false. Standardvärdet är false.
fileSystem	FileSystemTokenStore	Konfigurationsinställningarna för lagringen av token om ett filsystem används.
tokenRefreshExtensionHours	number	Antalet timmar efter att sessionstoken upphör att gälla som en sessionstoken kan användas för att anropa API:et för tokenuppdatering. Standardvärdet är 72 timmar.

Twitter

Object

Konfigurationsinställningarna för Twitter-providern.

Name	Typ	Description
enabled	boolean	false om Twitter-providern inte ska aktiveras trots den angivna registreringen. annars true.
registration	TwitterRegistration	Konfigurationsinställningarna för appregistreringen för Twitter-providern.

TwitterRegistration

Object

Konfigurationsinställningarna för appregistreringen för Twitter-providern.

Name	Typ	Description
consumerKey	string	OAuth 1.0a-konsumentnyckeln för Twitter-programmet som används för inloggning. Den här inställningen krävs för att aktivera Twitter-inloggning. Dokumentation om Twitter Sign-In: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	Namnet på appinställningen som innehåller OAuth 1.0a-konsumenthemligheten för Twitter-programmet som används för inloggning.

UnauthenticatedClientActionV2

Enumeration

Åtgärden som ska vidtas när en oautentiserad klient försöker komma åt appen.

Värde	Description
AllowAnonymous
RedirectToLoginPage
Return401
Return403