Web Apps - Get Auth Settings

Referência

Serviço:: App Service

Versão da API:: 2024-04-01

Descrição para Obter as configurações de Autenticação/Autorização de um aplicativo.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
name	path	True	string	Nome do aplicativo.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Padrão Regex: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	Sua ID de 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	SiteAuthSettings	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

Solicitação de exemplo

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


/**
 * Samples for WebApps GetAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
     */
    /**
     * Sample code: List Auth Settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsWithResponse("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.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(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.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/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/ListAuthSettings.json
func ExampleWebAppsClient_GetAuthSettings() {
	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().GetAuthSettings(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.SiteAuthSettings = armappservice.SiteAuthSettings{
	// 	Name: to.Ptr("authsettings"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettings"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsProperties{
	// 		AllowedExternalRedirectUrls: []*string{
	// 			to.Ptr("sitef6141.customdomain.net"),
	// 			to.Ptr("sitef6141.customdomain.info")},
	// 			ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 			DefaultProvider: to.Ptr(armappservice.BuiltInAuthenticationProviderGoogle),
	// 			Enabled: to.Ptr(true),
	// 			RuntimeVersion: to.Ptr("~1"),
	// 			TokenRefreshExtensionHours: to.Ptr[float64](120),
	// 			TokenStoreEnabled: to.Ptr(true),
	// 			UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionRedirectToLoginPage),
	// 		},
	// 	}
}

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 the Authentication/Authorization settings of an app.
 *
 * @summary Description for Gets the Authentication/Authorization settings of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
 */
async function listAuthSettings() {
  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.getAuthSettings(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

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/ListAuthSettings.json
// this example is just showing the usage of "WebApps_GetAuthSettings" 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
SiteAuthSettings result = await webSite.GetAuthSettingsAsync();

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

Resposta de exemplo

Código de status:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
  "name": "authsettings",
  "type": "Microsoft.Web/sites/authsettings",
  "kind": "app",
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Definições

Nome	Description
BuiltInAuthenticationProvider	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 de cliente não autenticada for definida como "RedirectToLoginPage".
DefaultErrorResponse	Resposta de erro do Serviço de Aplicativo.
Details
Error	Modelo de erro.
SiteAuthSettings	Configurações para o recurso autenticação/autorização do Serviço de Aplicativo do Azure.
UnauthenticatedClientAction	A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.

BuiltInAuthenticationProvider

Enumeration

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 de cliente não autenticada for definida como "RedirectToLoginPage".

Valor	Description
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

DefaultErrorResponse

Object

Resposta de erro do Serviço de Aplicativo.

Nome	Tipo	Description
error	Error	Modelo de erro.

Details

Object

Nome	Tipo	Description
code	string	Cadeia de caracteres padronizada para identificar programaticamente o erro.
message	string	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

Error

Object

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	Informações detalhadas de descrição e depuração de erros.
target	string	Informações detalhadas de descrição e depuração de erros.

SiteAuthSettings

Object

Configurações para o recurso autenticação/autorização 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.aadClaimsAuthorization	string	Obtém uma cadeia de caracteres JSON que contém as configurações de Acl do Azure AD.
properties.additionalLoginParams	string[]	Parâmetros de logon para enviar ao ponto de extremidade de autorização do OpenID Connect quando um usuário faz logon. Cada parâmetro deve estar no formato "key=value".
properties.allowedAudiences	string[]	Permitiu que os valores de audiência considerassem ao validar tokens Web JSON emitidos pelo Azure Active Directory. Observe que o valor `ClientID` é sempre considerado um público-alvo permitido, independentemente dessa configuração.
properties.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.
properties.authFilePath	string	O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, baseará o diretório raiz do site.
properties.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 do OpenID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	O Segredo do Cliente desse aplicativo de terceira parte confiável (no Azure Active Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícita do OpenID Connect será usado para autenticar os usuários finais. Caso contrário, o Fluxo de Código de Autorização do OpenID Connect será usado para autenticar usuários finais. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.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.
properties.clientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável.
properties.configVersion	string	A ConfigVersion do recurso autenticação/autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento do plano de controle para Autenticação/Autorização.
properties.defaultProvider	BuiltInAuthenticationProvider	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 de cliente não autenticada for definida como "RedirectToLoginPage".
properties.enabled	boolean	`true` se o recurso autenticação/autorização estiver habilitado para o aplicativo atual; caso contrário, `false`.
properties.facebookAppId	string	A ID do aplicativo do Facebook usada para logon. Essa configuração é necessária para habilitar o Logon do Facebook. Documentação de logon do Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	O Segredo do Aplicativo do aplicativo facebook usado para logon do Facebook. Essa configuração é necessária para habilitar o Logon do Facebook. Documentação de logon do Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do aplicativo usado para o Logon do Facebook.
properties.facebookOAuthScopes	string[]	Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do Facebook. Essa configuração é opcional. Documentação de logon do Facebook: https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	A ID do cliente do aplicativo GitHub usada para logon. Essa configuração é necessária para habilitar o logon do Github
properties.gitHubClientSecret	string	O Segredo do Cliente do aplicativo GitHub usado para o Logon do Github. Essa configuração é necessária para habilitar o logon do Github.
properties.gitHubClientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para o Logon do GitHub.
properties.gitHubOAuthScopes	string[]	Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do GitHub. Essa configuração é opcional
properties.googleClientId	string	A ID do cliente do OpenID Connect para o aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada do Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	O segredo do cliente associado ao aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada do Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente associado ao aplicativo Web do Google.
properties.googleOAuthScopes	string[]	Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação do Google Sign-In. Essa configuração é opcional. Se não for especificado, "openid", "profile" e "email" serão usados como escopos padrão. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" se as configurações de configuração de autenticação devem ser lidas de um arquivo, "false" caso contrário
properties.issuer	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://sts.windows.net/{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
properties.microsoftAccountClientId	string	A ID do cliente OAuth 2.0 que foi criada para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação do Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	O segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação do Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação.
properties.microsoftAccountOAuthScopes	string[]	Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação da Conta da Microsoft. Essa configuração é opcional. Se não for especificado, "wl.basic" será usado como o escopo padrão. Documentação de escopos e permissões de conta da Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.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.
properties.tokenRefreshExtensionHours	number	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.
properties.tokenStoreEnabled	boolean	`true` armazenar tokens de segurança específicos da plataforma que são obtidos durante os fluxos de logon; caso contrário, `false`. O padrão é `false`.
properties.twitterConsumerKey	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
properties.twitterConsumerSecret	string	O segredo 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
properties.twitterConsumerSecretSettingName	string	O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo twitter usado para entrar.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.
properties.validateIssuer	boolean	Obtém um valor que indica se o emissor deve ser uma URL HTTPS válida e ser validado como tal.
type	string	Tipo de recurso.

UnauthenticatedClientAction

Enumeration

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

Valor	Description
AllowAnonymous
RedirectToLoginPage