Web Apps - Get Auth Settings

Referencia

Servicio:: App Service

Versión de la API:: 2024-04-01

Descripción de Obtiene la configuración de autenticación y autorización de una aplicación.

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 identificador URI

Nombre	En	Requerido	Tipo	Description
name	path	True	string	Nombre de la aplicación.
resourceGroupName	path	True	string	Nombre del grupo de recursos al que pertenece el recurso. Patrón de Regex: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	Identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de API

Respuestas

Nombre	Tipo	Description
200 OK	SiteAuthSettings	De acuerdo
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

List Auth Settings

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
  }
}

Definiciones

Nombre	Description
BuiltInAuthenticationProvider	Proveedor de autenticación predeterminado que se va a usar cuando se configuran varios proveedores. Esta configuración solo es necesaria si se configuran varios proveedores y la acción de cliente no autenticada se establece en "RedirectToLoginPage".
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
SiteAuthSettings	Opciones de configuración para la característica autenticación y autorización de Azure App Service.
UnauthenticatedClientAction	Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación.

BuiltInAuthenticationProvider

Enumeration

Proveedor de autenticación predeterminado que se va a usar cuando se configuran varios proveedores. Esta configuración solo es necesaria si se configuran varios proveedores y la acción de cliente no autenticada se establece en "RedirectToLoginPage".

Valor	Description
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

SiteAuthSettings

Object

Opciones de configuración para la característica autenticación y autorización de Azure App Service.

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.aadClaimsAuthorization	string	Obtiene una cadena JSON que contiene la configuración de Acl de Azure AD.
properties.additionalLoginParams	string[]	Parámetros de inicio de sesión para enviar al punto de conexión de autorización de OpenID Connect cuando un usuario inicia sesión. Cada parámetro debe tener el formato "key=value".
properties.allowedAudiences	string[]	Valores de audiencia permitidos que se deben tener en cuenta al validar tokens web JSON emitidos por Azure Active Directory. Tenga en cuenta que el valor de `ClientID` siempre se considera una audiencia permitida, independientemente de esta configuración.
properties.allowedExternalRedirectUrls	string[]	Direcciones URL externas a las que se puede redirigir como parte del inicio de sesión o el inicio de sesión de la aplicación. Tenga en cuenta que se omite la parte de la cadena de consulta de la dirección URL. Se trata de una configuración avanzada que normalmente solo necesitan los back-end de aplicaciones de la Tienda Windows. Tenga en cuenta que las direcciones URL dentro del dominio actual siempre se permiten implícitamente.
properties.authFilePath	string	Ruta de acceso del archivo de configuración que contiene la configuración de autenticación. Si la ruta de acceso es relativa, base será el directorio raíz del sitio.
properties.clientId	string	El identificador de cliente de esta aplicación de usuario de confianza, conocido como el client_id. Esta configuración es necesaria para habilitar la autenticación de conexión openID con Azure Active Directory u otros proveedores de OpenID Connect de terceros. Más información sobre OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	El secreto de cliente de esta aplicación de usuario de confianza (en Azure Active Directory, esto también se conoce como clave). Esta configuración es opcional. Si no se configura ningún secreto de cliente, el flujo de autenticación implícita de OpenID Connect se usa para autenticar a los usuarios finales. De lo contrario, el flujo de código de autorización de OpenID Connect se usa para autenticar a los usuarios finales. Más información sobre OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativa al secreto de cliente, que es la huella digital de un certificado que se usa con fines de firma. Esta propiedad actúa como reemplazo del secreto de cliente. También es opcional.
properties.clientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente de la aplicación de usuario de confianza.
properties.configVersion	string	ConfigVersion de la característica Autenticación y autorización en uso para la aplicación actual. La configuración de este valor puede controlar el comportamiento del plano de control para autenticación o autorización.
properties.defaultProvider	BuiltInAuthenticationProvider	Proveedor de autenticación predeterminado que se va a usar cuando se configuran varios proveedores. Esta configuración solo es necesaria si se configuran varios proveedores y la acción de cliente no autenticada se establece en "RedirectToLoginPage".
properties.enabled	boolean	`true` si la característica autenticación o autorización está habilitada para la aplicación actual; de lo contrario, `false`.
properties.facebookAppId	string	El identificador de aplicación de la aplicación de Facebook que se usa para el inicio de sesión. Esta configuración es necesaria para habilitar el inicio de sesión de Facebook. Documentación de inicio de sesión de Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	El secreto de aplicación de la aplicación de Facebook que se usa para el inicio de sesión de Facebook. Esta configuración es necesaria para habilitar el inicio de sesión de Facebook. Documentación de inicio de sesión de Facebook: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	El nombre de configuración de la aplicación que contiene el secreto de la aplicación usado para el inicio de sesión de Facebook.
properties.facebookOAuthScopes	string[]	Ámbitos de OAuth 2.0 que se solicitarán como parte de la autenticación de inicio de sesión de Facebook. Esta configuración es opcional. Documentación de inicio de sesión de Facebook: https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	Identificador de cliente de la aplicación de GitHub que se usa para el inicio de sesión. Esta configuración es necesaria para habilitar el inicio de sesión de Github.
properties.gitHubClientSecret	string	Secreto de cliente de la aplicación de GitHub que se usa para el inicio de sesión de Github. Esta configuración es necesaria para habilitar el inicio de sesión de Github.
properties.gitHubClientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente de la aplicación de Github que se usa para el inicio de sesión de GitHub.
properties.gitHubOAuthScopes	string[]	Ámbitos de OAuth 2.0 que se solicitarán como parte de la autenticación de inicio de sesión de GitHub. Esta configuración es opcional.
properties.googleClientId	string	Identificador de cliente de OpenID Connect para la aplicación web de Google. Esta configuración es necesaria para habilitar el inicio de sesión de Google. Documentación de Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Secreto de cliente asociado a la aplicación web de Google. Esta configuración es necesaria para habilitar el inicio de sesión de Google. Documentación de Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente asociado a la aplicación web de Google.
properties.googleOAuthScopes	string[]	Los ámbitos de OAuth 2.0 que se solicitarán como parte de la autenticación de Google Sign-In. Esta configuración es opcional. Si no se especifica, se usan "openid", "profile" y "email" como ámbitos predeterminados. Documentación de Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" si la configuración de autenticación debe leerse desde un archivo, "false" de lo contrario.
properties.issuer	string	Identificador URI del emisor de OpenID Connect que representa la entidad que emite tokens de acceso para esta aplicación. Al usar Azure Active Directory, este valor es el URI del inquilino del directorio, por ejemplo, `https://sts.windows.net/{tenant-guid}/`. Este URI es un identificador que distingue mayúsculas de minúsculas para el emisor del token. Más información sobre la detección de OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	Identificador de cliente de OAuth 2.0 que se creó para la aplicación usada para la autenticación. Esta configuración es necesaria para habilitar la autenticación de la cuenta Microsoft. Documentación de OAuth de la cuenta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Secreto de cliente de OAuth 2.0 que se creó para la aplicación usada para la autenticación. Esta configuración es necesaria para habilitar la autenticación de la cuenta Microsoft. Documentación de OAuth de la cuenta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente de OAuth 2.0 que se creó para la aplicación que se usó para la autenticación.
properties.microsoftAccountOAuthScopes	string[]	Ámbitos de OAuth 2.0 que se solicitarán como parte de la autenticación de la cuenta Microsoft. Esta configuración es opcional. Si no se especifica, se usa "wl.basic" como ámbito predeterminado. Documentación sobre ámbitos y permisos de la cuenta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion de la característica Autenticación y autorización en uso para la aplicación actual. La configuración de este valor puede controlar el comportamiento de determinadas características en el módulo Autenticación y autorización.
properties.tokenRefreshExtensionHours	number	Número de horas después de la expiración del token de sesión que se puede usar un token de sesión para llamar a la API de actualización de tokens. El valor predeterminado es 72 horas.
properties.tokenStoreEnabled	boolean	`true` almacenar permanentemente tokens de seguridad específicos de la plataforma que se obtienen durante los flujos de inicio de sesión; de lo contrario, `false`. El valor predeterminado es `false`.
properties.twitterConsumerKey	string	La clave de consumidor de OAuth 1.0a de la aplicación de Twitter que se usa para el inicio de sesión. Esta configuración es necesaria para habilitar el inicio de sesión de Twitter. Documentación de twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Secreto de consumidor de OAuth 1.0a de la aplicación de Twitter que se usa para el inicio de sesión. Esta configuración es necesaria para habilitar el inicio de sesión de Twitter. Documentación de twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de consumidor de OAuth 1.0a de la aplicación de Twitter que se usa para el inicio de sesión.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación.
properties.validateIssuer	boolean	Obtiene un valor que indica si el emisor debe ser una dirección URL HTTPS válida y validarse como tal.
type	string	Tipo de recurso.

UnauthenticatedClientAction

Enumeration

Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación.

Valor	Description
AllowAnonymous
RedirectToLoginPage