Web Apps - Get Auth Settings V 2

Serviço:: App Service

Versão API:: 2025-03-01

Descrição das configurações de Autenticação/Autorização do site para aplicativos por meio do formato V2

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list?api-version=2025-03-01

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
name	path	True	string	Nome do aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Nome	Tipo	Descrição
200 OK	SiteAuthSettingsV2	Operação do Azure concluída com êxito.
Other Status Codes	DefaultErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

List Auth Settings V2

Pedido de exemplo

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


/**
 * Samples for WebApps GetAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/ListAuthSettingsV2.json
     */
    /**
     * Sample code: List Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsV2WithResponse("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_auth_settings_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.get_auth_settings_v2(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/ListAuthSettingsV2.json
if __name__ == "__main__":
    main()

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

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v5"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9f4cb2884f1948b879ecfb3f410e8cbc8805c213/specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/ListAuthSettingsV2.json
func ExampleWebAppsClient_GetAuthSettingsV2() {
	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().GetAuthSettingsV2(ctx, "testrg123", "sitef6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.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

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

/**
 * This sample demonstrates how to Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/AppService/stable/2025-03-01/examples/ListAuthSettingsV2.json
 */
async function listAuthSettingsV2() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAuthSettingsV2(resourceGroupName, name);
  console.log(result);
}

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

Resposta de exemplo

Código de estado:: 200

{
  "name": "authsettingsv2",
  "type": "Microsoft.Web/sites/authsettingsv2",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2",
  "kind": "app",
  "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"
    }
  }
}

Definições

Nome	Descrição
AllowedAudiencesValidation	As definições de configuração do fluxo de validação de Públicos Permitidos.
AllowedPrincipals	As definições de configuração do Ative Directory do Azure permitem entidades de segurança.
Apple	As definições de configuração do fornecedor Apple.
AppleRegistration	As definições de configuração do registo para o fornecedor Apple
AppRegistration	As definições de configuração do registro do aplicativo para provedores que têm IDs de aplicativo e segredos de aplicativo
AuthPlatform	As definições de configuração da plataforma de Autenticação/Autorização do Serviço de Aplicativo.
AzureActiveDirectory	As definições de configuração do provedor do Ative Directory do Azure.
AzureActiveDirectoryLogin	As definições de configuração do fluxo de logon do Azure Ative Directory.
AzureActiveDirectoryRegistration	As definições de configuração do registro do aplicativo Azure Ative Directory.
AzureActiveDirectoryValidation	As definições de configuração do fluxo de validação de token do Azure Ative Directory.
AzureStaticWebApps	As definições de configuração do provedor de Aplicativos Web Estáticos do Azure.
AzureStaticWebAppsRegistration	As definições de configuração do registro para o provedor de Aplicativos Web Estáticos do Azure
BlobStorageTokenStore	As definições de configuração do armazenamento dos tokens se o armazenamento de blob for usado.
ClientRegistration	As definições de configuração do registro do aplicativo para provedores que têm IDs de cliente e segredos de cliente
CookieExpiration	As definições de configuração da expiração do cookie de sessão.
CookieExpirationConvention	A convenção usada para determinar a expiração do cookie de sessão.
createdByType	O tipo de identidade que criou o recurso.
CustomOpenIdConnectProvider	As definições de configuração do provedor Open ID Connect personalizado.
DefaultAuthorizationPolicy	As definições de configuração da política de autorização padrão do Azure Ative Directory.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
DefaultErrorResponseError	Modelo de erro.
DefaultErrorResponseErrorDetailsItem	Erros detalhados.
Facebook	As definições de configuração do provedor do Facebook.
FileSystemTokenStore	As definições de configuração do armazenamento dos tokens se um sistema de arquivos for usado.
ForwardProxy	As definições de configuração de um proxy de encaminhamento usado para fazer as solicitações.
ForwardProxyConvention	A convenção usada para determinar a url da solicitação feita.
GitHub	As definições de configuração do provedor GitHub.
GlobalValidation	As definições de configuração que determinam o fluxo de validação dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
Google	As definições de configuração do provedor do Google.
HttpSettings	As definições de configuração das solicitações HTTP para autenticação e autorização feitas em relação à Autenticação/Autorização do Serviço de Aplicativo.
HttpSettingsRoutes	As definições de configuração das solicitações HTTP de caminhos.
IdentityProviders	As definições de configuração de cada um dos provedores de identidade usados para configurar a Autenticação/Autorização do Serviço de Aplicativo.
JwtClaimChecks	As definições de configuração das verificações que devem ser feitas durante a validação das declarações JWT.
LegacyMicrosoftAccount	As definições de configuração do provedor de conta da Microsoft herdado.
Login	As definições de configuração do fluxo de login dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
LoginRoutes	As rotas que especificam os pontos de extremidade usados para solicitações de login e logout.
LoginScopes	As definições de configuração do fluxo de login, incluindo os escopos que devem ser solicitados.
Nonce	As definições de configuração do nonce usado no fluxo de login.
OpenIdConnectClientCredential	As credenciais do cliente de autenticação do provedor Open ID Connect personalizado.
OpenIdConnectConfig	As definições de configuração dos pontos de extremidade usados para o provedor Open ID Connect personalizado.
OpenIdConnectLogin	As definições de configuração do fluxo de login do provedor personalizado Open ID Connect.
OpenIdConnectRegistration	As definições de configuração do registro do aplicativo para o provedor Open ID Connect personalizado.
SiteAuthSettingsV2	Definições de configuração para o recurso Autenticação / Autorização do Serviço de Aplicativo do Azure V2.
systemData	Metadados referentes à criação e última modificação do recurso.
TokenStore	As definições de configuração do armazenamento de tokens.
Twitter	As definições de configuração do provedor do Twitter.
TwitterRegistration	As definições de configuração do registro do aplicativo para o provedor do Twitter.
UnauthenticatedClientActionV2	A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.

AllowedAudiencesValidation

Objetivo

As definições de configuração do fluxo de validação de Públicos Permitidos.

Nome	Tipo	Descrição
allowedAudiences	string[]	As definições de configuração da lista permitida de audiências a partir das quais validar o token JWT.

AllowedPrincipals

Objetivo

As definições de configuração do Ative Directory do Azure permitem entidades de segurança.

Nome	Tipo	Descrição
groups	string[]	A lista dos grupos permitidos.
identities	string[]	A lista das identidades permitidas.

Apple

Objetivo

As definições de configuração do fornecedor Apple.

Nome	Tipo	Descrição
enabled	boolean	`false` se o fornecedor Apple não deve ser ativado apesar do registo definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de login.
registration	AppleRegistration	As definições de configuração do registo Apple.

AppleRegistration

Objetivo

As definições de configuração do registo para o fornecedor Apple

Nome	Tipo	Descrição
clientId	string	A ID do cliente do aplicativo usado para login.
clientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente.

AppRegistration

Objetivo

As definições de configuração do registro do aplicativo para provedores que têm IDs de aplicativo e segredos de aplicativo

Nome	Tipo	Descrição
appId	string	O ID do aplicativo usado para login.
appSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do aplicativo.

AuthPlatform

Objetivo

As definições de configuração da plataforma de Autenticação/Autorização do Serviço de Aplicativo.

Nome	Tipo	Descrição
configFilePath	string	O caminho do arquivo de configuração que contém as configurações de autenticação se elas vierem de um arquivo. Se o caminho for relativo, a base será o diretório raiz do site.
enabled	boolean	`true` se o recurso de Autenticação/Autorização estiver habilitado para o aplicativo atual; caso contrário, `false`.
runtimeVersion	string	O RuntimeVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração neste valor pode controlar o comportamento de determinados recursos no módulo Autenticação / Autorização.

AzureActiveDirectory

Objetivo

As definições de configuração do provedor do Ative Directory do Azure.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor do Azure Ative Directory não deve ser habilitado apesar do registro definido; caso contrário, `true`.
isAutoProvisioned	boolean	Obtém um valor que indica se a configuração do Azure AD foi provisionada automaticamente usando ferramentas de 1º partido. Este é um sinalizador interno destinado principalmente a dar suporte ao Portal de Gerenciamento do Azure. Os usuários não devem ler ou gravar nesta propriedade.
login	AzureActiveDirectoryLogin	As definições de configuração do fluxo de logon do Azure Ative Directory.
registration	AzureActiveDirectoryRegistration	As definições de configuração do registro do aplicativo Azure Ative Directory.
validation	AzureActiveDirectoryValidation	As definições de configuração do fluxo de validação de token do Azure Ative Directory.

AzureActiveDirectoryLogin

Objetivo

As definições de configuração do fluxo de logon do Azure Ative Directory.

Nome	Tipo	Descrição
disableWWWAuthenticate	boolean	`true` se o provedor www-authenticate deve ser omitido da solicitação; caso contrário, `false`.
loginParameters	string[]	Parâmetros de login para enviar ao ponto de extremidade de autorização do OpenID Connect quando um usuário fizer login. Cada parâmetro deve estar no formato "key=value".

AzureActiveDirectoryRegistration

Objetivo

As definições de configuração do registro do aplicativo Azure Ative Directory.

Nome	Tipo	Descrição
clientId	string	A ID do Cliente deste aplicativo de terceira parte confiável, conhecida como client_id. Essa configuração é necessária para habilitar a autenticação de Conexão OpenID com o Azure Ative Directory ou outros provedores OpenID Connect de terceiros 3rd. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Uma alternativa à impressão digital secreta do cliente, que é o emissor de um certificado usado para fins de assinatura. Esta propriedade atua como um substituto para a impressão digital do certificado secreto do cliente. Também é opcional.
clientSecretCertificateSubjectAlternativeName	string	Uma alternativa à impressão digital secreta do cliente, que é o nome alternativo do assunto de um certificado usado para fins de assinatura. Esta propriedade atua como um substituto para a impressão digital do certificado secreto do cliente. Também é opcional.
clientSecretCertificateThumbprint	string	Uma alternativa ao segredo do cliente, que é a impressão digital de um certificado usado para fins de assinatura. Esta propriedade atua como um substituto para o Segredo do Cliente. Também é opcional.
clientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável.
openIdIssuer	string	O URI do Emissor do OpenID Connect que representa a entidade que emite tokens de acesso para este aplicativo. Ao usar o Azure Ative Directory, esse valor é o URI do locatário do diretório, por exemplo, `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. Esse URI é um identificador que diferencia maiúsculas de minúsculas para o emissor do token. Mais informações sobre o OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Objetivo

As definições de configuração do fluxo de validação de token do Azure Ative Directory.

Nome	Tipo	Descrição
allowedAudiences	string[]	A lista de audiências que podem fazer solicitações de autenticação/autorização bem-sucedidas.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	As definições de configuração da política de autorização padrão.
jwtClaimChecks	JwtClaimChecks	As definições de configuração das verificações que devem ser feitas durante a validação das declarações JWT.

AzureStaticWebApps

Objetivo

As definições de configuração do provedor de Aplicativos Web Estáticos do Azure.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor de Aplicativos Web Estáticos do Azure não deve ser habilitado apesar do registro definido; caso contrário, `true`.
registration	AzureStaticWebAppsRegistration	As definições de configuração do registro dos Aplicativos Web Estáticos do Azure.

AzureStaticWebAppsRegistration

Objetivo

As definições de configuração do registro para o provedor de Aplicativos Web Estáticos do Azure

Nome	Tipo	Descrição
clientId	string	A ID do cliente do aplicativo usado para login.

BlobStorageTokenStore

Objetivo

As definições de configuração do armazenamento dos tokens se o armazenamento de blob for usado.

Nome	Tipo	Descrição
sasUrlSettingName	string	O nome da configuração do aplicativo que contém a URL SAS do armazenamento de blob que contém os tokens.

ClientRegistration

Objetivo

As definições de configuração do registro do aplicativo para provedores que têm IDs de cliente e segredos de cliente

Nome	Tipo	Descrição
clientId	string	A ID do cliente do aplicativo usado para login.
clientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente.

CookieExpiration

Objetivo

As definições de configuração da expiração do cookie de sessão.

Nome	Tipo	Descrição
convention	CookieExpirationConvention	A convenção usada para determinar a expiração do cookie de sessão.
timeToExpiration	string	O tempo após a solicitação é feito quando o cookie de sessão deve expirar.

CookieExpirationConvention

Enumeração

A convenção usada para determinar a expiração do cookie de sessão.

Valor	Descrição
FixedTime
IdentityProviderDerived

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

CustomOpenIdConnectProvider

Objetivo

As definições de configuração do provedor Open ID Connect personalizado.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor de provedor Open ID personalizado não deve ser habilitado; caso contrário, `true`.
login	OpenIdConnectLogin	As definições de configuração do fluxo de login do provedor personalizado Open ID Connect.
registration	OpenIdConnectRegistration	As definições de configuração do registro do aplicativo para o provedor Open ID Connect personalizado.

DefaultAuthorizationPolicy

Objetivo

As definições de configuração da política de autorização padrão do Azure Ative Directory.

Nome	Tipo	Descrição
allowedApplications	string[]	As definições de configuração dos aplicativos permitidos do Azure Ative Directory.
allowedPrincipals	AllowedPrincipals	As definições de configuração do Ative Directory do Azure permitem entidades de segurança.

DefaultErrorResponse

Objetivo

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Descrição
error	DefaultErrorResponseError	Modelo de erro.

DefaultErrorResponseError

Objetivo

Modelo de erro.

Nome	Tipo	Descrição
code	string	String padronizada para identificar programaticamente o erro.
details	DefaultErrorResponseErrorDetailsItem[]	Erros detalhados.
innererror	string	Mais informações para depurar erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

DefaultErrorResponseErrorDetailsItem

Objetivo

Erros detalhados.

Nome	Tipo	Descrição
code	string	String padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Facebook

Objetivo

As definições de configuração do provedor do Facebook.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor do Facebook não deve ser habilitado apesar do registro definido; caso contrário, `true`.
graphApiVersion	string	A versão da api do Facebook a ser usada durante o login.
login	LoginScopes	As definições de configuração do fluxo de login.
registration	AppRegistration	As definições de configuração do registro do aplicativo para o provedor do Facebook.

FileSystemTokenStore

Objetivo

As definições de configuração do armazenamento dos tokens se um sistema de arquivos for usado.

Nome	Tipo	Descrição
directory	string	O diretório no qual os tokens serão armazenados.

ForwardProxy

Objetivo

As definições de configuração de um proxy de encaminhamento usado para fazer as solicitações.

Nome	Tipo	Descrição
convention	ForwardProxyConvention	A convenção usada para determinar a url da solicitação feita.
customHostHeaderName	string	O nome do cabeçalho que contém o host da solicitação.
customProtoHeaderName	string	O nome do cabeçalho que contém o esquema da solicitação.

ForwardProxyConvention

Enumeração

A convenção usada para determinar a url da solicitação feita.

Valor	Descrição
NoProxy
Standard
Custom

GitHub

Objetivo

As definições de configuração do provedor GitHub.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor GitHub não deve ser habilitado apesar do registro definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de login.
registration	ClientRegistration	As definições de configuração do registro do aplicativo para o provedor GitHub.

GlobalValidation

Objetivo

As definições de configuração que determinam o fluxo de validação dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.

Nome	Tipo	Descrição
excludedPaths	string[]	Os caminhos para os quais o fluxo não autenticado não seria redirecionado para a página de login.
redirectToProvider	string	O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só é necessária se vários provedores estiverem configurados e a ação do cliente não autenticado estiver definida como "RedirectToLoginPage".
requireAuthentication	boolean	`true` se o fluxo de autenticação for necessário, qualquer solicitação será feita; caso contrário, `false`.
unauthenticatedClientAction	UnauthenticatedClientActionV2	A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.

Google

Objetivo

As definições de configuração do provedor do Google.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor do Google não deve ser habilitado apesar do registro definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de login.
registration	ClientRegistration	As definições de configuração do registro do aplicativo para o provedor do Google.
validation	AllowedAudiencesValidation	As definições de configuração do fluxo de validação de token do Azure Ative Directory.

HttpSettings

Objetivo

As definições de configuração das solicitações HTTP para autenticação e autorização feitas em relação à Autenticação/Autorização do Serviço de Aplicativo.

Nome	Tipo	Descrição
forwardProxy	ForwardProxy	As definições de configuração de um proxy de encaminhamento usado para fazer as solicitações.
requireHttps	boolean	`false` se as respostas de autenticação/autorização que não têm o esquema HTTPS são permitidas; caso contrário, `true`.
routes	HttpSettingsRoutes	As definições de configuração das solicitações HTTP de caminhos.

HttpSettingsRoutes

Objetivo

As definições de configuração das solicitações HTTP de caminhos.

Nome	Tipo	Descrição
apiPrefix	string	O prefixo que deve preceder todos os caminhos de autenticação/autorização.

IdentityProviders

Objetivo

As definições de configuração de cada um dos provedores de identidade usados para configurar a Autenticação/Autorização do Serviço de Aplicativo.

Nome	Tipo	Descrição
apple	Apple	As definições de configuração do fornecedor Apple.
azureActiveDirectory	AzureActiveDirectory	As definições de configuração do provedor do Ative Directory do Azure.
azureStaticWebApps	AzureStaticWebApps	As definições de configuração do provedor de Aplicativos Web Estáticos do Azure.
customOpenIdConnectProviders	<string, CustomOpenIdConnectProvider>	O mapa do nome do alias de cada provedor Open ID Connect personalizado para as definições de configuração do provedor Open ID Connect personalizado.
facebook	Facebook	As definições de configuração do provedor do Facebook.
gitHub	GitHub	As definições de configuração do provedor GitHub.
google	Google	As definições de configuração do provedor do Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	As definições de configuração do provedor de conta da Microsoft herdado.
twitter	Twitter	As definições de configuração do provedor do Twitter.

JwtClaimChecks

Objetivo

As definições de configuração das verificações que devem ser feitas durante a validação das declarações JWT.

Nome	Tipo	Descrição
allowedClientApplications	string[]	A lista dos aplicativos cliente permitidos.
allowedGroups	string[]	A lista dos grupos permitidos.

LegacyMicrosoftAccount

Objetivo

As definições de configuração do provedor de conta da Microsoft herdado.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor de conta da Microsoft herdado não deve ser habilitado apesar do registro definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de login.
registration	ClientRegistration	As definições de configuração do registro do aplicativo para o provedor de Conta da Microsoft herdado.
validation	AllowedAudiencesValidation	As definições de configuração do fluxo de validação de token do provedor de conta da Microsoft herdado.

Objetivo

As definições de configuração do fluxo de login dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.

Nome	Tipo	Descrição
allowedExternalRedirectUrls	string[]	URLs externos que podem ser redirecionados como parte do login ou logout do aplicativo. Observe que a parte da cadeia de caracteres de consulta da URL é ignorada. Essa é uma configuração avançada normalmente necessária apenas para back-ends de aplicativos da Windows Store. Observe que as URLs dentro do domínio atual são sempre permitidas implicitamente.
cookieExpiration	CookieExpiration	As definições de configuração da expiração do cookie de sessão.
nonce	Nonce	As definições de configuração do nonce usado no fluxo de login.
preserveUrlFragmentsForLogins	boolean	`true` se os fragmentos da solicitação forem preservados após a solicitação de login ser feita; caso contrário, `false`.
routes	LoginRoutes	As rotas que especificam os pontos de extremidade usados para solicitações de login e logout.
tokenStore	TokenStore	As definições de configuração do armazenamento de tokens.

LoginRoutes

Objetivo

As rotas que especificam os pontos de extremidade usados para solicitações de login e logout.

Nome	Tipo	Descrição
logoutEndpoint	string	O ponto de extremidade no qual uma solicitação de logout deve ser feita.

LoginScopes

Objetivo

As definições de configuração do fluxo de login, incluindo os escopos que devem ser solicitados.

Nome	Tipo	Descrição
scopes	string[]	Uma lista dos escopos que devem ser solicitados durante a autenticação.

Nonce

Objetivo

As definições de configuração do nonce usado no fluxo de login.

Nome	Tipo	Descrição
nonceExpirationInterval	string	O tempo após o pedido é feito quando o nonce deve expirar.
validateNonce	boolean	`false` se o nonce não deve ser validado ao completar o fluxo de login; caso contrário, `true`.

OpenIdConnectClientCredential

Objetivo

As credenciais do cliente de autenticação do provedor Open ID Connect personalizado.

Nome	Tipo	Descrição
clientSecretSettingName	string	A configuração do aplicativo que contém o segredo do cliente para o provedor Open ID Connect personalizado.
method	enum: ClientSecretPost	O método que deve ser usado para autenticar o usuário.

OpenIdConnectConfig

Objetivo

As definições de configuração dos pontos de extremidade usados para o provedor Open ID Connect personalizado.

Nome	Tipo	Descrição
authorizationEndpoint	string	O ponto de extremidade a ser usado para fazer uma solicitação de autorização.
certificationUri	string	O ponto de extremidade que fornece as chaves necessárias para validar o token.
issuer	string	O ponto de extremidade que emite o token.
tokenEndpoint	string	O ponto de extremidade a ser usado para solicitar um token.
wellKnownOpenIdConfiguration	string	O ponto de extremidade que contém todos os pontos de extremidade de configuração para o provedor.

OpenIdConnectLogin

Objetivo

As definições de configuração do fluxo de login do provedor personalizado Open ID Connect.

Nome	Tipo	Descrição
nameClaimType	string	O nome da declaração que contém o nome dos usuários.
scopes	string[]	Uma lista dos escopos que devem ser solicitados durante a autenticação.

OpenIdConnectRegistration

Objetivo

As definições de configuração do registro do aplicativo para o provedor Open ID Connect personalizado.

Nome	Tipo	Descrição
clientCredential	OpenIdConnectClientCredential	As credenciais de autenticação do provedor Open ID Connect personalizado.
clientId	string	A ID do cliente do provedor Open ID Connect personalizado.
openIdConnectConfiguration	OpenIdConnectConfig	As definições de configuração dos pontos de extremidade usados para o provedor Open ID Connect personalizado.

SiteAuthSettingsV2

Objetivo

Definições de configuração para o recurso Autenticação / Autorização do Serviço de Aplicativo do Azure V2.

Nome	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso. Se o recurso for um aplicativo, você pode consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obter detalhes sobre os valores suportados para o tipo.
name	string	O nome do recurso
properties.globalValidation	GlobalValidation	As definições de configuração que determinam o fluxo de validação dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
properties.httpSettings	HttpSettings	As definições de configuração das solicitações HTTP para autenticação e autorização feitas em relação à Autenticação/Autorização do Serviço de Aplicativo.
properties.identityProviders	IdentityProviders	As definições de configuração de cada um dos provedores de identidade usados para configurar a Autenticação/Autorização do Serviço de Aplicativo.
properties.login	Login	As definições de configuração do fluxo de login dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
properties.platform	AuthPlatform	As definições de configuração da plataforma de Autenticação/Autorização do Serviço de Aplicativo.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Objetivo

Metadados referentes à criação e última modificação do recurso.

Nome	Tipo	Descrição
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TokenStore

Objetivo

As definições de configuração do armazenamento de tokens.

Nome	Tipo	Descrição
azureBlobStorage	BlobStorageTokenStore	As definições de configuração do armazenamento dos tokens se o armazenamento de blob for usado.
enabled	boolean	`true` armazenar de forma durável tokens de segurança específicos da plataforma que são obtidos durante os fluxos de login; caso contrário, `false`. A predefinição é `false`.
fileSystem	FileSystemTokenStore	As definições de configuração do armazenamento dos tokens se um sistema de arquivos for usado.
tokenRefreshExtensionHours	number (double)	O número de horas após a expiração do token de sessão que um token de sessão pode ser usado para chamar a API de atualização de token. A predefinição são 72 horas.

Twitter

Objetivo

As definições de configuração do provedor do Twitter.

Nome	Tipo	Descrição
enabled	boolean	`false` se o provedor do Twitter não deve ser habilitado apesar do registro definido; caso contrário, `true`.
registration	TwitterRegistration	As definições de configuração do registro do aplicativo para o provedor do Twitter.

TwitterRegistration

Objetivo

As definições de configuração do registro do aplicativo para o provedor do Twitter.

Nome	Tipo	Descrição
consumerKey	string	A chave de consumidor OAuth 1.0a do aplicativo Twitter usada para entrar. Essa configuração é necessária para habilitar o Login do Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar.

UnauthenticatedClientActionV2

Enumeração

A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.

Valor	Descrição
RedirectToLoginPage
AllowAnonymous
Return401
Return403

Partilhar via

Web Apps - Get Auth Settings V 2

Parâmetros URI

Respostas

Segurança

azure_auth

Alcances

Exemplos

List Auth Settings V2

Pedido de exemplo

Resposta de exemplo

Definições

AllowedAudiencesValidation

AllowedPrincipals

Apple

AppleRegistration

AppRegistration

AuthPlatform

AzureActiveDirectory

AzureActiveDirectoryLogin

AzureActiveDirectoryRegistration

AzureActiveDirectoryValidation

AzureStaticWebApps

AzureStaticWebAppsRegistration

BlobStorageTokenStore

ClientRegistration

CookieExpiration

CookieExpirationConvention

createdByType

CustomOpenIdConnectProvider

DefaultAuthorizationPolicy

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

Facebook

FileSystemTokenStore

ForwardProxy

ForwardProxyConvention

GitHub

GlobalValidation

Google

HttpSettings

HttpSettingsRoutes

IdentityProviders

JwtClaimChecks

LegacyMicrosoftAccount

Login

LoginRoutes

LoginScopes

Nonce

OpenIdConnectClientCredential

OpenIdConnectConfig

OpenIdConnectLogin

OpenIdConnectRegistration

SiteAuthSettingsV2

systemData

TokenStore

Twitter

TwitterRegistration

UnauthenticatedClientActionV2