Web Apps - Update Auth Settings
Descripción de Novedades la configuración de autenticación y autorización asociada a la aplicación web.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings?api-version=2023-12-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
name
|
path | True |
string |
Nombre de la aplicación web. |
resource
|
path | True |
string |
Nombre del grupo de recursos al que pertenece el recurso. Regex pattern: |
subscription
|
path | True |
string |
Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-0000-0000-0000-00000000000000). |
api-version
|
query | True |
string |
Versión de la API |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
kind |
string |
Tipo de 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 |
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 la parte de la cadena de consulta de la dirección URL se omite. 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 de 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 |
Una 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 la 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 |
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 |
|
properties.facebookAppId |
string |
El identificador de aplicación de la aplicación Facebook que se usa para el inicio de sesión. Esta configuración es necesaria para habilitar Facebook inicio de sesión. Facebook documentación de inicio de sesión:https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecret |
string |
El secreto de aplicación de la aplicación Facebook que se usa para el inicio de sesión de Facebook. Esta configuración es necesaria para habilitar Facebook inicio de sesión. Facebook documentación de inicio de sesión:https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecretSettingName |
string |
Nombre de la configuración de la aplicación que contiene el secreto de la aplicación que se usa para Facebook inicio de sesión. |
properties.facebookOAuthScopes |
string[] |
Ámbitos de OAuth 2.0 que se solicitarán como parte de Facebook autenticación de inicio de sesión. Esta configuración es opcional. Facebook documentación de inicio de sesión: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 la 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 |
Id. 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, "openid", "profile" y "email" se usan 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" en caso contrario. |
properties.issuer |
string |
El URI del emisor de OpenID Connect que representa la entidad que emite tokens de acceso para esta aplicación. Cuando se usa Azure Active Directory, este valor es el URI del inquilino de 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 |
El nombre de la configuración de la aplicación que contiene el secreto de cliente de OAuth 2.0 que se creó para la aplicación usada 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 los á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 para llamar a la API de actualización de tokens. El valor predeterminado es 72 horas. |
properties.tokenStoreEnabled |
boolean |
|
properties.twitterConsumerKey |
string |
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 Sign-In de Twitter: https://dev.twitter.com/web/sign-in |
properties.twitterConsumerSecret |
string |
El 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 Sign-In de Twitter: 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 |
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. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
Aceptar |
|
Other Status Codes |
App Service respuesta de error. |
Seguridad
azure_auth
Flujo OAuth2 de Azure Active Directory
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
Update Auth Settings
Sample Request
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings?api-version=2023-12-01
{
"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"
}
}
Sample Response
{
"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 |
---|---|
Built |
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". |
Default |
App Service respuesta de error. |
Details | |
Error |
Modelo de error. |
Site |
Opciones de configuración para la característica autenticación y autorización de Azure App Service. |
Unauthenticated |
Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación. |
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".
Nombre | Tipo | Description |
---|---|---|
AzureActiveDirectory |
string |
|
string |
||
Github |
string |
|
string |
||
MicrosoftAccount |
string |
|
string |
DefaultErrorResponse
App Service respuesta de error.
Nombre | Tipo | Description |
---|---|---|
error |
Modelo de error. |
Details
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
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
Opciones de configuración para la característica autenticación y autorización de Azure App Service.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Id. 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 que se van a 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 |
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 la aplicación 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 de 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, 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 |
Una 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 la 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. El valor de este valor puede controlar el comportamiento del plano de control para autenticación o autorización. |
properties.defaultProvider |
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 |
|
properties.facebookAppId |
string |
El identificador de aplicación de la aplicación Facebook que se usa para el inicio de sesión. Esta configuración es necesaria para habilitar Facebook inicio de sesión. Facebook documentación de inicio de sesión:https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecret |
string |
Secreto de aplicación de la aplicación de Facebook que se usa para Facebook inicio de sesión. Esta configuración es necesaria para habilitar Facebook inicio de sesión. Facebook documentación de inicio de sesión:https://developers.facebook.com/docs/facebook-login |
properties.facebookAppSecretSettingName |
string |
Nombre de la configuración de la aplicación que contiene el secreto de la aplicación que se usa para Facebook inicio de sesión. |
properties.facebookOAuthScopes |
string[] |
Los ámbitos de OAuth 2.0 que se solicitarán como parte de Facebook autenticación de inicio de sesión. Esta configuración es opcional. Facebook documentación de inicio de sesión:https://developers.facebook.com/docs/facebook-login |
properties.gitHubClientId |
string |
El 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 |
El nombre de la 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[] |
Los á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" en caso contrario. |
properties.issuer |
string |
El URI del emisor de OpenID Connect que representa la entidad que emite tokens de acceso para esta aplicación. Cuando se usa 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 |
El 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 usada para la autenticación. |
properties.microsoftAccountOAuthScopes |
string[] |
Los á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 del 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 |
|
properties.twitterConsumerKey |
string |
La clave de consumidor de OAuth 1.0a de la aplicación de Twitter usada para el inicio de sesión. Esta configuración es necesaria para habilitar el inicio de sesión de Twitter. Documentación de Sign-In de Twitter: 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 Sign-In de Twitter: https://dev.twitter.com/web/sign-in |
properties.twitterConsumerSecretSettingName |
string |
El 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 |
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
Acción que se debe realizar cuando un cliente no autenticado intenta acceder a la aplicación.
Nombre | Tipo | Description |
---|---|---|
AllowAnonymous |
string |
|
RedirectToLoginPage |
string |