Web Apps - Get Auth Settings V2

Servicio:

App Service

Versión de la API:

2024-04-01

Descripción de obtiene la configuración de autenticación y autorización del sitio para las aplicaciones a través del formato V2.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/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	SiteAuthSettingsV2	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 V2

Solicitud de ejemplo

HTTP

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

Java

/**
 * Samples for WebApps GetAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-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

Python

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/stable/2024-04-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

Go

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/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

JavaScript

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/stable/2024-04-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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
// this example is just showing the usage of "WebApps_GetAuthSettingsV2" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
SiteAuthSettingsV2 result = await webSite.GetAuthSettingsV2Async();

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

Definiciones

Nombre	Description
AllowedAudiencesValidation	Las opciones de configuración del flujo de validación audiencias permitidas.
AllowedPrincipals	Las opciones de configuración de las entidades de seguridad permitidas de Azure Active Directory.
Apple	Las opciones de configuración del proveedor de Apple.
AppleRegistration	Las opciones de configuración del registro para el proveedor de Apple
AppRegistration	Las opciones de configuración del registro de aplicaciones para proveedores que tienen identificadores de aplicación y secretos de aplicación
AuthPlatform	Las opciones de configuración de la plataforma de autenticación o autorización de App Service.
AzureActiveDirectory	Las opciones de configuración del proveedor de Azure Active Directory.
AzureActiveDirectoryLogin	Las opciones de configuración del flujo de inicio de sesión de Azure Active Directory.
AzureActiveDirectoryRegistration	Las opciones de configuración del registro de aplicaciones de Azure Active Directory.
AzureActiveDirectoryValidation	Las opciones de configuración del flujo de validación de tokens de Azure Active Directory.
AzureStaticWebApps	Las opciones de configuración del proveedor de Azure Static Web Apps.
AzureStaticWebAppsRegistration	Las opciones de configuración del registro para el proveedor de Azure Static Web Apps
BlobStorageTokenStore	Las opciones de configuración del almacenamiento de los tokens si se usa Blob Storage.
ClientCredentialMethod	Método que se debe usar para autenticar al usuario.
ClientRegistration	Opciones de configuración del registro de aplicaciones para proveedores que tienen identificadores de cliente y secretos de cliente
CookieExpiration	Las opciones de configuración de la expiración de la cookie de sesión.
CookieExpirationConvention	La convención utilizada al determinar la expiración de la cookie de sesión.
CustomOpenIdConnectProvider	Las opciones de configuración del proveedor personalizado open ID Connect.
DefaultAuthorizationPolicy	Las opciones de configuración de la directiva de autorización predeterminada de Azure Active Directory.
DefaultErrorResponse	Respuesta de error de App Service.
Details
Error	Modelo de error.
Facebook	Las opciones de configuración del proveedor de Facebook.
FileSystemTokenStore	Las opciones de configuración del almacenamiento de los tokens si se usa un sistema de archivos.
ForwardProxy	Los valores de configuración de un proxy de reenvío usado para realizar las solicitudes.
ForwardProxyConvention	Convención utilizada para determinar la dirección URL de la solicitud realizada.
GitHub	Las opciones de configuración del proveedor de GitHub.
GlobalValidation	Las opciones de configuración que determinan el flujo de validación de los usuarios mediante la autenticación o autorización de App Service.
Google	Las opciones de configuración del proveedor de Google.
HttpSettings	Las opciones de configuración de las solicitudes HTTP para las solicitudes de autenticación y autorización realizadas en la autenticación y autorización de App Service.
HttpSettingsRoutes	Las opciones de configuración de las solicitudes HTTP de las rutas de acceso.
IdentityProviders	Las opciones de configuración de cada uno de los proveedores de identidades usados para configurar la autenticación o autorización de App Service.
JwtClaimChecks	Las opciones de configuración de las comprobaciones que se deben realizar al validar las notificaciones JWT.
LegacyMicrosoftAccount	Las opciones de configuración del proveedor de cuentas microsoft heredadas.
Login	Las opciones de configuración del flujo de inicio de sesión de los usuarios mediante la autenticación y autorización de App Service.
LoginRoutes	Rutas que especifican los puntos de conexión usados para las solicitudes de inicio de sesión y cierre de sesión.
LoginScopes	Las opciones de configuración del flujo de inicio de sesión, incluidos los ámbitos que se deben solicitar.
Nonce	Las opciones de configuración de nonce usadas en el flujo de inicio de sesión.
OpenIdConnectClientCredential	Las credenciales de cliente de autenticación del proveedor personalizado de Open ID Connect.
OpenIdConnectConfig	Las opciones de configuración de los puntos de conexión usados para el proveedor personalizado de Open ID Connect.
OpenIdConnectLogin	Los valores de configuración del flujo de inicio de sesión del proveedor personalizado de Open ID Connect.
OpenIdConnectRegistration	Las opciones de configuración del registro de aplicaciones para el proveedor personalizado de Open ID Connect.
SiteAuthSettingsV2	Opciones de configuración para la característica Autenticación y autorización de Azure App Service V2.
TokenStore	Las opciones de configuración del almacén de tokens.
Twitter	Las opciones de configuración del proveedor de Twitter.
TwitterRegistration	Las opciones de configuración del registro de aplicaciones para el proveedor de Twitter.
UnauthenticatedClientActionV2	Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación.

AllowedAudiencesValidation

Object

Las opciones de configuración del flujo de validación audiencias permitidas.

Nombre	Tipo	Description
allowedAudiences	string[]	Las opciones de configuración de la lista de audiencias permitidas desde las que se va a validar el token JWT.

AllowedPrincipals

Object

Las opciones de configuración de las entidades de seguridad permitidas de Azure Active Directory.

Nombre	Tipo	Description
groups	string[]	Lista de los grupos permitidos.
identities	string[]	Lista de las identidades permitidas.

Apple

Object

Las opciones de configuración del proveedor de Apple.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de Apple no debe habilitarse a pesar del registro establecido; de lo contrario, true.
login	LoginScopes	Las opciones de configuración del flujo de inicio de sesión.
registration	AppleRegistration	Las opciones de configuración del registro de Apple.

AppleRegistration

Object

Las opciones de configuración del registro para el proveedor de Apple

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la aplicación usada para el inicio de sesión.
clientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente.

AppRegistration

Object

Las opciones de configuración del registro de aplicaciones para proveedores que tienen identificadores de aplicación y secretos de aplicación

Nombre	Tipo	Description
appId	string	Id. de aplicación de la aplicación que se usa para el inicio de sesión.
appSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de la aplicación.

AuthPlatform

Object

Las opciones de configuración de la plataforma de autenticación o autorización de App Service.

Nombre	Tipo	Description
configFilePath	string	Ruta de acceso del archivo de configuración que contiene la configuración de autenticación si proceden de un archivo. Si la ruta de acceso es relativa, base será el directorio raíz del sitio.
enabled	boolean	true si la característica autenticación o autorización está habilitada para la aplicación actual; de lo contrario, false.
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.

AzureActiveDirectory

Object

Las opciones de configuración del proveedor de Azure Active Directory.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de Azure Active Directory no debe habilitarse a pesar del registro establecido; de lo contrario, true.
isAutoProvisioned	boolean	Obtiene un valor que indica si la configuración de Azure AD se aprovisionó automáticamente mediante herramientas de terceros. Se trata de una marca interna pensada principalmente para admitir el Portal de administración de Azure. Los usuarios no deben leer ni escribir en esta propiedad.
login	AzureActiveDirectoryLogin	Las opciones de configuración del flujo de inicio de sesión de Azure Active Directory.
registration	AzureActiveDirectoryRegistration	Las opciones de configuración del registro de aplicaciones de Azure Active Directory.
validation	AzureActiveDirectoryValidation	Las opciones de configuración del flujo de validación de tokens de Azure Active Directory.

AzureActiveDirectoryLogin

Object

Las opciones de configuración del flujo de inicio de sesión de Azure Active Directory.

Nombre	Tipo	Description
disableWWWAuthenticate	boolean	true si se debe omitir el proveedor www-authenticate de la solicitud; de lo contrario, false.
loginParameters	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".

AzureActiveDirectoryRegistration

Object

Las opciones de configuración del registro de aplicaciones de Azure Active Directory.

Nombre	Tipo	Description
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
clientSecretCertificateIssuer	string	Alternativa a la huella digital del secreto de cliente, que es el emisor de un certificado que se usa con fines de firma. Esta propiedad actúa como reemplazo de la huella digital del certificado secreto de cliente. También es opcional.
clientSecretCertificateSubjectAlternativeName	string	Una alternativa a la huella digital del secreto de cliente, que es el nombre alternativo del firmante de un certificado que se usa con fines de firma. Esta propiedad actúa como reemplazo de la huella digital del certificado secreto de cliente. También es opcional.
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.
clientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente de la aplicación de usuario de confianza.
openIdIssuer	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://login.microsoftonline.com/v2.0/{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

AzureActiveDirectoryValidation

Object

Las opciones de configuración del flujo de validación de tokens de Azure Active Directory.

Nombre	Tipo	Description
allowedAudiences	string[]	Lista de audiencias que pueden realizar solicitudes de autenticación y autorización correctas.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Las opciones de configuración de la directiva de autorización predeterminada.
jwtClaimChecks	JwtClaimChecks	Las opciones de configuración de las comprobaciones que se deben realizar al validar las notificaciones JWT.

AzureStaticWebApps

Object

Las opciones de configuración del proveedor de Azure Static Web Apps.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de Azure Static Web Apps no debe estar habilitado a pesar del registro establecido; de lo contrario, true.
registration	AzureStaticWebAppsRegistration	Las opciones de configuración del registro de Azure Static Web Apps.

AzureStaticWebAppsRegistration

Object

Las opciones de configuración del registro para el proveedor de Azure Static Web Apps

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la aplicación usada para el inicio de sesión.

BlobStorageTokenStore

Object

Las opciones de configuración del almacenamiento de los tokens si se usa Blob Storage.

Nombre	Tipo	Description
sasUrlSettingName	string	Nombre de la configuración de la aplicación que contiene la dirección URL de SAS del almacenamiento de blobs que contiene los tokens.

ClientCredentialMethod

Enumeration

Método que se debe usar para autenticar al usuario.

Valor	Description
ClientSecretPost

ClientRegistration

Object

Opciones de configuración del registro de aplicaciones para proveedores que tienen identificadores de cliente y secretos de cliente

Nombre	Tipo	Description
clientId	string	Identificador de cliente de la aplicación usada para el inicio de sesión.
clientSecretSettingName	string	Nombre de configuración de la aplicación que contiene el secreto de cliente.

CookieExpiration

Object

Las opciones de configuración de la expiración de la cookie de sesión.

Nombre	Tipo	Description
convention	CookieExpirationConvention	La convención utilizada al determinar la expiración de la cookie de sesión.
timeToExpiration	string	El tiempo después de que se realice la solicitud cuando la cookie de sesión debe expirar.

CookieExpirationConvention

Enumeration

La convención utilizada al determinar la expiración de la cookie de sesión.

Valor	Description
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

Las opciones de configuración del proveedor personalizado open ID Connect.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de proveedor de Open ID personalizado no debe estar habilitado; de lo contrario, true.
login	OpenIdConnectLogin	Los valores de configuración del flujo de inicio de sesión del proveedor personalizado de Open ID Connect.
registration	OpenIdConnectRegistration	Las opciones de configuración del registro de aplicaciones para el proveedor personalizado de Open ID Connect.

DefaultAuthorizationPolicy

Object

Las opciones de configuración de la directiva de autorización predeterminada de Azure Active Directory.

Nombre	Tipo	Description
allowedApplications	string[]	Las opciones de configuración de las aplicaciones permitidas de Azure Active Directory.
allowedPrincipals	AllowedPrincipals	Las opciones de configuración de las entidades de seguridad permitidas de Azure Active Directory.

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.

Facebook

Object

Las opciones de configuración del proveedor de Facebook.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de Facebook no debe habilitarse a pesar del registro establecido; de lo contrario, true.
graphApiVersion	string	Versión de la API de Facebook que se va a usar al iniciar sesión.
login	LoginScopes	Las opciones de configuración del flujo de inicio de sesión.
registration	AppRegistration	Las opciones de configuración del registro de la aplicación para el proveedor de Facebook.

FileSystemTokenStore

Object

Las opciones de configuración del almacenamiento de los tokens si se usa un sistema de archivos.

Nombre	Tipo	Description
directory	string	Directorio en el que se almacenarán los tokens.

ForwardProxy

Object

Los valores de configuración de un proxy de reenvío usado para realizar las solicitudes.

Nombre	Tipo	Description
convention	ForwardProxyConvention	Convención utilizada para determinar la dirección URL de la solicitud realizada.
customHostHeaderName	string	Nombre del encabezado que contiene el host de la solicitud.
customProtoHeaderName	string	Nombre del encabezado que contiene el esquema de la solicitud.

ForwardProxyConvention

Enumeration

Convención utilizada para determinar la dirección URL de la solicitud realizada.

Valor	Description
Custom
NoProxy
Standard

GitHub

Object

Las opciones de configuración del proveedor de GitHub.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de GitHub no debe habilitarse a pesar del registro establecido; de lo contrario, true.
login	LoginScopes	Las opciones de configuración del flujo de inicio de sesión.
registration	ClientRegistration	Las opciones de configuración del registro de aplicaciones para el proveedor de GitHub.

GlobalValidation

Object

Las opciones de configuración que determinan el flujo de validación de los usuarios mediante la autenticación o autorización de App Service.

Nombre	Tipo	Description
excludedPaths	string[]	Las rutas de acceso para las que el flujo no autenticado no se redirigiría a la página de inicio de sesión.
redirectToProvider	string	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".
requireAuthentication	boolean	true si se requiere el flujo de autenticación alguna solicitud; de lo contrario, false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación.

Google

Object

Las opciones de configuración del proveedor de Google.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de Google no debe habilitarse a pesar del registro establecido; de lo contrario, true.
login	LoginScopes	Las opciones de configuración del flujo de inicio de sesión.
registration	ClientRegistration	Las opciones de configuración del registro de aplicaciones para el proveedor de Google.
validation	AllowedAudiencesValidation	Las opciones de configuración del flujo de validación de tokens de Azure Active Directory.

HttpSettings

Object

Las opciones de configuración de las solicitudes HTTP para las solicitudes de autenticación y autorización realizadas en la autenticación y autorización de App Service.

Nombre	Tipo	Description
forwardProxy	ForwardProxy	Los valores de configuración de un proxy de reenvío usado para realizar las solicitudes.
requireHttps	boolean	false si las respuestas de autenticación y autorización que no tienen el esquema HTTPS están permitidos; de lo contrario, true.
routes	HttpSettingsRoutes	Las opciones de configuración de las solicitudes HTTP de las rutas de acceso.

HttpSettingsRoutes

Object

Las opciones de configuración de las solicitudes HTTP de las rutas de acceso.

Nombre	Tipo	Description
apiPrefix	string	Prefijo que debe preceder a todas las rutas de acceso de autenticación y autorización.

IdentityProviders

Object

Las opciones de configuración de cada uno de los proveedores de identidades usados para configurar la autenticación o autorización de App Service.

Nombre	Tipo	Description
apple	Apple	Las opciones de configuración del proveedor de Apple.
azureActiveDirectory	AzureActiveDirectory	Las opciones de configuración del proveedor de Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	Las opciones de configuración del proveedor de Azure Static Web Apps.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Mapa del nombre del alias de cada proveedor personalizado de Open ID Connect a los valores de configuración del proveedor personalizado de Open ID Connect.
facebook	Facebook	Las opciones de configuración del proveedor de Facebook.
gitHub	GitHub	Las opciones de configuración del proveedor de GitHub.
google	Google	Las opciones de configuración del proveedor de Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Las opciones de configuración del proveedor de cuentas microsoft heredadas.
twitter	Twitter	Las opciones de configuración del proveedor de Twitter.

JwtClaimChecks

Object

Las opciones de configuración de las comprobaciones que se deben realizar al validar las notificaciones JWT.

Nombre	Tipo	Description
allowedClientApplications	string[]	Lista de las aplicaciones cliente permitidas.
allowedGroups	string[]	Lista de los grupos permitidos.

LegacyMicrosoftAccount

Object

Las opciones de configuración del proveedor de cuentas microsoft heredadas.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de cuentas Microsoft heredado no debe estar habilitado a pesar del registro establecido; de lo contrario, true.
login	LoginScopes	Las opciones de configuración del flujo de inicio de sesión.
registration	ClientRegistration	Las opciones de configuración del registro de la aplicación para el proveedor de la cuenta Microsoft heredada.
validation	AllowedAudiencesValidation	Las opciones de configuración del flujo de validación de tokens del proveedor de cuentas microsoft heredadas.

Login

Object

Las opciones de configuración del flujo de inicio de sesión de los usuarios mediante la autenticación y autorización de App Service.

Nombre	Tipo	Description
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.
cookieExpiration	CookieExpiration	Las opciones de configuración de la expiración de la cookie de sesión.
nonce	Nonce	Las opciones de configuración de nonce usadas en el flujo de inicio de sesión.
preserveUrlFragmentsForLogins	boolean	true si los fragmentos de la solicitud se conservan después de realizar la solicitud de inicio de sesión; de lo contrario, false.
routes	LoginRoutes	Rutas que especifican los puntos de conexión usados para las solicitudes de inicio de sesión y cierre de sesión.
tokenStore	TokenStore	Las opciones de configuración del almacén de tokens.

LoginRoutes

Object

Rutas que especifican los puntos de conexión usados para las solicitudes de inicio de sesión y cierre de sesión.

Nombre	Tipo	Description
logoutEndpoint	string	Punto de conexión en el que se debe realizar una solicitud de cierre de sesión.

LoginScopes

Object

Las opciones de configuración del flujo de inicio de sesión, incluidos los ámbitos que se deben solicitar.

Nombre	Tipo	Description
scopes	string[]	Lista de los ámbitos que se deben solicitar durante la autenticación.

Nonce

Object

Las opciones de configuración de nonce usadas en el flujo de inicio de sesión.

Nombre	Tipo	Description
nonceExpirationInterval	string	El tiempo después de que se realice la solicitud cuando el nonce debe expirar.
validateNonce	boolean	false si no se debe validar el nonce al completar el flujo de inicio de sesión; de lo contrario, true.

OpenIdConnectClientCredential

Object

Las credenciales de cliente de autenticación del proveedor personalizado de Open ID Connect.

Nombre	Tipo	Description
clientSecretSettingName	string	Configuración de la aplicación que contiene el secreto de cliente para el proveedor personalizado de Open ID Connect.
method	ClientCredentialMethod	Método que se debe usar para autenticar al usuario.

OpenIdConnectConfig

Object

Las opciones de configuración de los puntos de conexión usados para el proveedor personalizado de Open ID Connect.

Nombre	Tipo	Description
authorizationEndpoint	string	Punto de conexión que se va a usar para realizar una solicitud de autorización.
certificationUri	string	Punto de conexión que proporciona las claves necesarias para validar el token.
issuer	string	Punto de conexión que emite el token.
tokenEndpoint	string	Punto de conexión que se va a usar para solicitar un token.
wellKnownOpenIdConfiguration	string	Punto de conexión que contiene todos los puntos de conexión de configuración del proveedor.

OpenIdConnectLogin

Object

Los valores de configuración del flujo de inicio de sesión del proveedor personalizado de Open ID Connect.

Nombre	Tipo	Description
nameClaimType	string	Nombre de la notificación que contiene el nombre de los usuarios.
scopes	string[]	Lista de los ámbitos que se deben solicitar durante la autenticación.

OpenIdConnectRegistration

Object

Las opciones de configuración del registro de aplicaciones para el proveedor personalizado de Open ID Connect.

Nombre	Tipo	Description
clientCredential	OpenIdConnectClientCredential	Las credenciales de autenticación del proveedor personalizado de Open ID Connect.
clientId	string	Identificador de cliente del proveedor personalizado open ID Connect.
openIdConnectConfiguration	OpenIdConnectConfig	Las opciones de configuración de los puntos de conexión usados para el proveedor personalizado de Open ID Connect.

SiteAuthSettingsV2

Object

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

Nombre	Tipo	Description
id	string	Identificador de recurso.
kind	string	Tipo de recurso.
name	string	Nombre del recurso.
properties.globalValidation	GlobalValidation	Las opciones de configuración que determinan el flujo de validación de los usuarios mediante la autenticación o autorización de App Service.
properties.httpSettings	HttpSettings	Las opciones de configuración de las solicitudes HTTP para las solicitudes de autenticación y autorización realizadas en la autenticación y autorización de App Service.
properties.identityProviders	IdentityProviders	Las opciones de configuración de cada uno de los proveedores de identidades usados para configurar la autenticación o autorización de App Service.
properties.login	Login	Las opciones de configuración del flujo de inicio de sesión de los usuarios mediante la autenticación y autorización de App Service.
properties.platform	AuthPlatform	Las opciones de configuración de la plataforma de autenticación o autorización de App Service.
type	string	Tipo de recurso.

TokenStore

Object

Las opciones de configuración del almacén de tokens.

Nombre	Tipo	Description
azureBlobStorage	BlobStorageTokenStore	Las opciones de configuración del almacenamiento de los tokens si se usa Blob Storage.
enabled	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.
fileSystem	FileSystemTokenStore	Las opciones de configuración del almacenamiento de los tokens si se usa un sistema de archivos.
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.

Twitter

Object

Las opciones de configuración del proveedor de Twitter.

Nombre	Tipo	Description
enabled	boolean	false si el proveedor de Twitter no debe habilitarse a pesar del registro establecido; de lo contrario, true.
registration	TwitterRegistration	Las opciones de configuración del registro de aplicaciones para el proveedor de Twitter.

TwitterRegistration

Object

Las opciones de configuración del registro de aplicaciones para el proveedor de Twitter.

Nombre	Tipo	Description
consumerKey	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
consumerSecretSettingName	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.

UnauthenticatedClientActionV2

Enumeration

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

Valor	Description
AllowAnonymous
RedirectToLoginPage
Return401
Return403