Web Apps - Get Auth Settings V 2

Serviço:: App Service

Versão da API:: 2025-03-01

Descrição das configurações de autenticação/autorização do site Obtém 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 de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do aplicativo.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nome do grupo de recursos ao qual o recurso pertence.
subscriptionId	path	True	string	Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada por GUID (por exemplo, 000000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Versão da API

Respostas

Nome	Tipo	Description
200 OK	SiteAuthSettingsV2	OKEY
Other Status Codes	DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

List Auth Settings V2

Solicitação 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 status:: 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"
      }
    }
  }
}

Definições

Nome	Description
AllowedAudiencesValidation	As configurações do fluxo de validação de Audiências Permitidas.
AllowedPrincipals	As configurações das entidades de segurança permitidas pelo Azure Active Directory.
Apple	As configurações do provedor da Apple.
AppleRegistration	As configurações do registro para o provedor da Apple
AppRegistration	As configurações do registro do aplicativo para provedores que têm IDs de aplicativo e segredos do aplicativo
AuthPlatform	As configurações da plataforma de Autenticação/Autorização do Serviço de Aplicativo.
AzureActiveDirectory	As configurações do provedor do Azure Active Directory.
AzureActiveDirectoryLogin	As configurações do fluxo de logon do Azure Active Directory.
AzureActiveDirectoryRegistration	As configurações do registro de aplicativo do Azure Active Directory.
AzureActiveDirectoryValidation	As configurações do fluxo de validação de token do Azure Active Directory.
AzureStaticWebApps	As configurações do provedor de Aplicativos Web Estáticos do Azure.
AzureStaticWebAppsRegistration	As configurações do registro para o provedor de Aplicativos Web Estáticos do Azure
BlobStorageTokenStore	As configurações do armazenamento dos tokens se o armazenamento de blobs for usado.
ClientCredentialMethod	O método que deve ser usado para autenticar o usuário.
ClientRegistration	As configurações do registro do aplicativo para provedores que têm IDs de cliente e segredos do cliente
CookieExpiration	As configurações da expiração do cookie de sessão.
CookieExpirationConvention	A convenção usada ao determinar a expiração do cookie de sessão.
CustomOpenIdConnectProvider	As configurações do provedor personalizado do Open ID Connect.
DefaultAuthorizationPolicy	As configurações da política de autorização padrão do Azure Active Directory.
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
Facebook	As configurações do provedor do Facebook.
FileSystemTokenStore	As configurações do armazenamento dos tokens se um sistema de arquivos for usado.
ForwardProxy	As configurações de um proxy de encaminhamento usadas para fazer as solicitações.
ForwardProxyConvention	A convenção usada para determinar a URL da solicitação feita.
GitHub	As configurações do provedor do GitHub.
GlobalValidation	As configurações que determinam o fluxo de validação de usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
Google	As configurações do provedor do Google.
HttpSettings	As configurações das solicitações HTTP para solicitações de autenticação e autorização feitas na Autenticação/Autorização do Serviço de Aplicativo.
HttpSettingsRoutes	As configurações das solicitações HTTP dos caminhos.
IdentityProviders	As configurações de cada um dos provedores de identidade usados para configurar a Autenticação/Autorização do Serviço de Aplicativo.
JwtClaimChecks	As configurações das verificações que devem ser feitas durante a validação das Declarações JWT.
LegacyMicrosoftAccount	As configurações do provedor de Conta da Microsoft herdado.
Login	As configurações do fluxo de logon 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 logoff e logoff.
LoginScopes	As configurações do fluxo de logon, incluindo os escopos que devem ser solicitados.
Nonce	As configurações do nonce usado no fluxo de logon.
OpenIdConnectClientCredential	As credenciais do cliente de autenticação do provedor personalizado Open ID Connect.
OpenIdConnectConfig	As configurações dos pontos de extremidade usados para o provedor personalizado do Open ID Connect.
OpenIdConnectLogin	As configurações do fluxo de logon do provedor personalizado do Open ID Connect.
OpenIdConnectRegistration	As configurações do registro do aplicativo para o provedor personalizado do Open ID Connect.
SiteAuthSettingsV2	Definições de configuração para o recurso de Autenticação/Autorização V2 do Serviço de Aplicativo do Azure.
TokenStore	As configurações do repositório de tokens.
Twitter	As configurações do provedor do Twitter.
TwitterRegistration	As configurações 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

Objeto

As configurações do fluxo de validação de Audiências Permitidas.

Nome	Tipo	Description
allowedAudiences	string[]	As configurações da lista de públicos permitidos das quais validar o token JWT.

AllowedPrincipals

Objeto

As configurações das entidades de segurança permitidas pelo Azure Active Directory.

Nome	Tipo	Description
groups	string[]	A lista dos grupos permitidos.
identities	string[]	A lista das identidades permitidas.

Apple

Objeto

As configurações do provedor da Apple.

Nome	Tipo	Description
enabled	boolean	`false` se o provedor da Apple não deve ser habilitado apesar do registro definido; caso contrário, `true`.
login	LoginScopes	As configurações do fluxo de logon.
registration	AppleRegistration	As configurações do registro da Apple.

AppleRegistration

Objeto

As configurações do registro para o provedor da Apple

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

AppRegistration

Objeto

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

Nome	Tipo	Description
appId	string	A ID do aplicativo usada para logon.
appSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do aplicativo.

AuthPlatform

Objeto

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

Nome	Tipo	Description
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, baseará o diretório raiz do site.
enabled	boolean	`true` se o recurso Autenticação/Autorização estiver habilitado para o aplicativo atual; caso contrário, `false`.
runtimeVersion	string	O runtimeVersion do recurso autenticação/autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento de determinados recursos no módulo Autenticação/Autorização.

AzureActiveDirectory

Objeto

As configurações do provedor do Azure Active Directory.

Nome	Tipo	Description
enabled	boolean	`false` se o provedor do Azure Active 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ª parte. Esse é um sinalizador interno destinado principalmente ao Portal de Gerenciamento do Azure. Os usuários não devem ler ou gravar nessa propriedade.
login	AzureActiveDirectoryLogin	As configurações do fluxo de logon do Azure Active Directory.
registration	AzureActiveDirectoryRegistration	As configurações do registro de aplicativo do Azure Active Directory.
validation	AzureActiveDirectoryValidation	As configurações do fluxo de validação de token do Azure Active Directory.

AzureActiveDirectoryLogin

Objeto

As configurações do fluxo de logon do Azure Active Directory.

Nome	Tipo	Description
disableWWWAuthenticate	boolean	`true` se o provedor www-authenticate deve ser omitido da solicitação; caso contrário, `false`.
loginParameters	string[]	Parâmetros de login a serem enviados para o 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

Objeto

As configurações do registro de aplicativo do Azure Active Directory.

Nome	Tipo	Description
clientId	string	A ID do cliente desse 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 Active Directory ou outros provedores OpenID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Uma alternativa à impressão digital do segredo do cliente, que é o emissor de um certificado usado para fins de assinatura. Essa propriedade atua como uma substituição para a impressão digital do certificado secreto do cliente. Também é opcional.
clientSecretCertificateSubjectAlternativeName	string	Uma alternativa à impressão digital do segredo do cliente, que é o nome alternativo da entidade de um certificado usado para fins de assinatura. Essa propriedade atua como uma substituição 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. Essa propriedade atua como uma substituição 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 Active 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 a Descoberta do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Objeto

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

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

AzureStaticWebApps

Objeto

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

Nome	Tipo	Description
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 configurações do registro de Aplicativos Web Estáticos do Azure.

AzureStaticWebAppsRegistration

Objeto

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

Nome	Tipo	Description
clientId	string	A ID do cliente do aplicativo usado para logon.

BlobStorageTokenStore

Objeto

As configurações do armazenamento dos tokens se o armazenamento de blobs for usado.

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

ClientCredentialMethod

Enumeração

O método que deve ser usado para autenticar o usuário.

Valor	Description
ClientSecretPost

ClientRegistration

Objeto

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

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

CookieExpiration

Objeto

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

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

CookieExpirationConvention

Enumeração

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

Valor	Description
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Objeto

As configurações do provedor personalizado do Open ID Connect.

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

DefaultAuthorizationPolicy

Objeto

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

Nome	Tipo	Description
allowedApplications	string[]	As configurações dos aplicativos permitidos do Azure Active Directory.
allowedPrincipals	AllowedPrincipals	As configurações das entidades de segurança permitidas pelo Azure Active Directory.

DefaultErrorResponse

Objeto

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Objeto

Nome	Tipo	Description
code	string	Cadeia de caracteres 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.

Error

Objeto

Modelo de erro.

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar 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

Objeto

As configurações do provedor do Facebook.

Nome	Tipo	Description
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 logon.
login	LoginScopes	As configurações do fluxo de logon.
registration	AppRegistration	As configurações do registro do aplicativo para o provedor do Facebook.

FileSystemTokenStore

Objeto

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

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

ForwardProxy

Objeto

As configurações de um proxy de encaminhamento usadas para fazer as solicitações.

Nome	Tipo	Description
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	Description
NoProxy
Standard
Custom

GitHub

Objeto

As configurações do provedor do GitHub.

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

GlobalValidation

Objeto

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

Nome	Tipo	Description
excludedPaths	string[]	Os caminhos para os quais o fluxo não autenticado não seria redirecionado para a página de logon.
redirectToProvider	string	O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só será 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

Objeto

As configurações do provedor do Google.

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

HttpSettings

Objeto

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

Nome	Tipo	Description
forwardProxy	ForwardProxy	As configurações de um proxy de encaminhamento usadas 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 configurações das solicitações HTTP dos caminhos.

HttpSettingsRoutes

Objeto

As configurações das solicitações HTTP dos caminhos.

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

IdentityProviders

Objeto

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

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

JwtClaimChecks

Objeto

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

Nome	Tipo	Description
allowedClientApplications	string[]	A lista de aplicativos cliente permitidos.
allowedGroups	string[]	A lista dos grupos permitidos.

LegacyMicrosoftAccount

Objeto

As configurações do provedor de Conta da Microsoft herdado.

Nome	Tipo	Description
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 configurações do fluxo de logon.
registration	ClientRegistration	As configurações do registro do aplicativo para o provedor de Conta da Microsoft herdado.
validation	AllowedAudiencesValidation	As configurações do fluxo de validação de token do provedor de conta da Microsoft herdado.

Objeto

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

Nome	Tipo	Description
allowedExternalRedirectUrls	string[]	URLs externas que podem ser redirecionadas como parte do logon ou do registro em log 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 configurações da expiração do cookie de sessão.
nonce	Nonce	As configurações do nonce usado no fluxo de logon.
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 logoff e logoff.
tokenStore	TokenStore	As configurações do repositório de tokens.

LoginRoutes

Objeto

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

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

LoginScopes

Objeto

As configurações do fluxo de logon, incluindo os escopos que devem ser solicitados.

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

Nonce

Objeto

As configurações do nonce usado no fluxo de logon.

Nome	Tipo	Description
nonceExpirationInterval	string	O tempo após a solicitação é feita quando o nonce deve expirar.
validateNonce	boolean	`false` se o nonce não deve ser validado durante a conclusão do fluxo de login; caso contrário, `true`.

OpenIdConnectClientCredential

Objeto

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

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

OpenIdConnectConfig

Objeto

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

Nome	Tipo	Description
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

Objeto

As configurações do fluxo de logon do provedor personalizado do Open ID Connect.

Nome	Tipo	Description
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

Objeto

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

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

SiteAuthSettingsV2

Objeto

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

Nome	Tipo	Description
id	string	ID do recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.globalValidation	GlobalValidation	As configurações que determinam o fluxo de validação de usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
properties.httpSettings	HttpSettings	As configurações das solicitações HTTP para solicitações de autenticação e autorização feitas na Autenticação/Autorização do Serviço de Aplicativo.
properties.identityProviders	IdentityProviders	As configurações de cada um dos provedores de identidade usados para configurar a Autenticação/Autorização do Serviço de Aplicativo.
properties.login	Login	As configurações do fluxo de logon dos usuários usando a Autenticação/Autorização do Serviço de Aplicativo.
properties.platform	AuthPlatform	As configurações da plataforma de Autenticação/Autorização do Serviço de Aplicativo.
type	string	Tipo de recurso.

TokenStore

Objeto

As configurações do repositório de tokens.

Nome	Tipo	Description
azureBlobStorage	BlobStorageTokenStore	As configurações do armazenamento dos tokens se o armazenamento de blobs for usado.
enabled	boolean	`true` para 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`. O padrão é `false`.
fileSystem	FileSystemTokenStore	As configurações 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. O padrão é 72 horas.

Twitter

Objeto

As configurações do provedor do Twitter.

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

TwitterRegistration

Objeto

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

Nome	Tipo	Description
consumerKey	string	A chave do consumidor OAuth 1.0a do aplicativo twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação da Sign-In do Twitter: 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 entrada.

UnauthenticatedClientActionV2

Enumeração

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

Valor	Description
RedirectToLoginPage
AllowAnonymous
Return401
Return403

Compartilhar via

Web Apps - Get Auth Settings V 2

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

List Auth Settings V2

Solicitação de exemplo

Resposta de exemplo

Definições

AllowedAudiencesValidation

AllowedPrincipals

Apple

AppleRegistration

AppRegistration

AuthPlatform

AzureActiveDirectory

AzureActiveDirectoryLogin

AzureActiveDirectoryRegistration

AzureActiveDirectoryValidation

AzureStaticWebApps

AzureStaticWebAppsRegistration

BlobStorageTokenStore

ClientCredentialMethod

ClientRegistration

CookieExpiration

CookieExpirationConvention

CustomOpenIdConnectProvider

DefaultAuthorizationPolicy

DefaultErrorResponse

Details

Error

Facebook

FileSystemTokenStore

ForwardProxy

ForwardProxyConvention

GitHub

GlobalValidation

Google

HttpSettings

HttpSettingsRoutes

IdentityProviders

JwtClaimChecks

LegacyMicrosoftAccount

Login

LoginRoutes

LoginScopes

Nonce

OpenIdConnectClientCredential

OpenIdConnectConfig

OpenIdConnectLogin

OpenIdConnectRegistration

SiteAuthSettingsV2

TokenStore

Twitter

TwitterRegistration

UnauthenticatedClientActionV2