Web Apps - Update Auth Settings

Descrição para Atualizações as definições de Autenticação/Autorização associadas à aplicação Web.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings?api-version=2023-12-01

Parâmetros do URI

Name Em Necessário Tipo Description
name
path True

string

Nome da aplicação Web.

resourceGroupName
path True

string

Nome do grupo de recursos ao qual o recurso pertence.

Padrão Regex: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).

api-version
query True

string

Versão da API

Corpo do Pedido

Name Tipo Description
kind

string

Tipo de recurso.

properties.aadClaimsAuthorization

string

Obtém uma cadeia JSON que contém as definições do Azure AD Acl.

properties.additionalLoginParams

string[]

Parâmetros de início de sessão para enviar para o ponto final de autorização do OpenID Connect quando um utilizador inicia sessão. Cada parâmetro tem de estar no formato "key=value".

properties.allowedAudiences

string[]

Permitiu que os valores de audiência considerassem ao validar os Tokens Web JSON emitidos pelo Azure Active Directory. Tenha em atenção que o ClientID valor é sempre considerado uma audiência permitida, independentemente desta definição.

properties.allowedExternalRedirectUrls

string[]

URLs externos para os quais pode ser redirecionado como parte do início de sessão ou de fim de sessão da aplicação. Tenha em atenção que a parte da cadeia de consulta do URL é ignorada. Normalmente, esta é uma definição avançada necessária apenas para back-ends de aplicações da Loja Windows. Tenha em atenção que os URLs dentro do domínio atual são sempre implicitamente permitidos.

properties.authFilePath

string

O caminho do ficheiro de configuração que contém as definições de autenticação. Se o caminho for relativo, a base será o diretório de raiz do site.

properties.clientId

string

O ID de Cliente desta aplicação de entidade confiadora, conhecida como client_id. Esta definição é necessária para ativar a autenticação da Ligação OpenID com o Azure Active Directory ou outros fornecedores 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 desta aplicação de entidade confiadora (no Azure Active Directory, também é conhecido como a Chave). Esta definição é opcional. Se não estiver configurado nenhum segredo do cliente, o fluxo de autenticação implícita do OpenID Connect é utilizado para autenticar os utilizadores finais. Caso contrário, o Fluxo de Código de Autorização do OpenID Connect é utilizado para autenticar os utilizadores 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 é o thumbprint de um certificado utilizado para fins de assinatura. Esta propriedade atua como um substituto do Segredo do Cliente. Também é opcional.

properties.clientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente da aplicação da entidade confiadora.

properties.configVersion

string

A ConfigVersion da funcionalidade Autenticação/Autorização em utilização para a aplicação atual. A definição neste valor pode controlar o comportamento do plano de controlo para Autenticação/Autorização.

properties.defaultProvider

BuiltInAuthenticationProvider

O fornecedor de autenticação predefinido a utilizar quando vários fornecedores estão configurados. Esta definição só é necessária se vários fornecedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

properties.enabled

boolean

true se a funcionalidade Autenticação/Autorização estiver ativada para a aplicação atual; caso contrário, false.

properties.facebookAppId

string

O ID da Aplicação da aplicação Facebook utilizada para iniciar sessão. Esta definição é necessária para ativar Facebook Início de Sessão. Facebook Documentação de início de sessão:https://developers.facebook.com/docs/facebook-login

properties.facebookAppSecret

string

O Segredo da Aplicação da aplicação Facebook utilizada para Facebook Início de Sessão. Esta definição é necessária para ativar Facebook Início de Sessão. Facebook Documentação de início de sessão:https://developers.facebook.com/docs/facebook-login

properties.facebookAppSecretSettingName

string

O nome da definição da aplicação que contém o segredo da aplicação utilizado para Facebook Início de Sessão.

properties.facebookOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação de Início de Sessão do Facebook. Esta definição é opcional. Facebook Documentação de início de sessão:https://developers.facebook.com/docs/facebook-login

properties.gitHubClientId

string

O ID de Cliente da aplicação GitHub utilizada para iniciar sessão. Esta definição é necessária para ativar o início de sessão no Github

properties.gitHubClientSecret

string

O Segredo do Cliente da aplicação GitHub utilizada para o Início de Sessão do Github. Esta definição é necessária para ativar o início de sessão do Github.

properties.gitHubClientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente da aplicação Github utilizada para o Início de Sessão do GitHub.

properties.gitHubOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação de Início de Sessão do GitHub. Esta definição é opcional

properties.googleClientId

string

O ID de Cliente do OpenID Connect para a aplicação Web da Google. Esta definição é necessária para ativar o Início de Sessão do Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.googleClientSecret

string

O segredo do cliente associado à aplicação Web google. Esta definição é necessária para ativar o Início de Sessão do Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.googleClientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente associado à aplicação Web google.

properties.googleOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação do Google Sign-In. Esta definição é opcional. Se não for especificado, "openid", "profile" e "email" são utilizados como âmbitos predefinidos. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.isAuthFromFile

string

"true" se as definições de configuração de autenticação devem ser lidas a partir de um ficheiro, caso contrário, "falso"

properties.issuer

string

O URI do Emissor do OpenID Connect que representa a entidade que emite tokens de acesso para esta aplicação. Ao utilizar o Azure Active Directory, este valor é o URI do inquilino do diretório, por exemplo, https://sts.windows.net/{tenant-guid}/. Este URI é um identificador sensível às maiúsculas e minúsculas do emissor do token. Mais informações sobre a Deteção do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

properties.microsoftAccountClientId

string

O ID de cliente OAuth 2.0 que foi criado para a aplicação utilizada para autenticação. Esta definição é necessária para ativar a autenticação da Conta Microsoft. Documentação do OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm

properties.microsoftAccountClientSecret

string

O segredo do cliente OAuth 2.0 que foi criado para a aplicação utilizada para autenticação. Esta definição é necessária para ativar a autenticação da Conta Microsoft. Documentação do OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm

properties.microsoftAccountClientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente OAuth 2.0 que foi criado para a aplicação utilizada para autenticação.

properties.microsoftAccountOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação da Conta Microsoft. Esta definição é opcional. Se não for especificado, "wl.basic" é utilizado como o âmbito predefinido. Documentação de Âmbitos e permissões da Conta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx

properties.runtimeVersion

string

A RuntimeVersion da funcionalidade Autenticação/Autorização em utilização para a aplicação atual. A definição neste valor pode controlar o comportamento de determinadas funcionalidades 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 utilizado para chamar a API de atualização de tokens. A predefinição são 72 horas.

properties.tokenStoreEnabled

boolean

true para armazenar de forma duradoura tokens de segurança específicos da plataforma que são obtidos durante os fluxos de início de sessão; caso contrário, false. A predefinição é false.

properties.twitterConsumerKey

string

A chave de consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão. Esta definição é necessária para ativar o Início de Sessão no Twitter. Documentação de Sign-In do Twitter: https://dev.twitter.com/web/sign-in

properties.twitterConsumerSecret

string

O segredo do consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão. Esta definição é necessária para ativar o Início de Sessão no Twitter. Documentação de Sign-In do Twitter: https://dev.twitter.com/web/sign-in

properties.twitterConsumerSecretSettingName

string

O nome da definição da aplicação que contém o segredo de consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão.

properties.unauthenticatedClientAction

UnauthenticatedClientAction

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

properties.validateIssuer

boolean

Obtém um valor que indica se o emissor deve ser um URL HTTPS válido e ser validado como tal.

Respostas

Name Tipo Description
200 OK

SiteAuthSettings

OK

Other Status Codes

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation representar a sua conta de utilizador

Exemplos

Update Auth Settings

Pedido de amostra

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

Resposta da amostra

{
  "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

Name Description
BuiltInAuthenticationProvider

O fornecedor de autenticação predefinido a utilizar quando vários fornecedores estão configurados. Esta definição só é necessária se vários fornecedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Details
Error

Modelo de erro.

SiteAuthSettings

Definições de configuração para a funcionalidade autenticação/autorização do Serviço de Aplicações do Azure.

UnauthenticatedClientAction

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

BuiltInAuthenticationProvider

O fornecedor de autenticação predefinido a utilizar quando vários fornecedores estão configurados. Esta definição só é necessária se vários fornecedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

Name Tipo Description
AzureActiveDirectory

string

Facebook

string

Github

string

Google

string

MicrosoftAccount

string

Twitter

string

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name Tipo Description
error

Error

Modelo de erro.

Details

Name Tipo Description
code

string

Cadeia padronizada para identificar programaticamente o erro.

message

string

Descrição detalhada do erro e informações de depuração.

target

string

Descrição detalhada do erro e informações de depuração.

Error

Modelo de erro.

Name Tipo Description
code

string

Cadeia padronizada para identificar programaticamente o erro.

details

Details[]

Erros detalhados.

innererror

string

Mais informações para depurar o erro.

message

string

Descrição detalhada do erro e informações de depuração.

target

string

Descrição detalhada do erro e informações de depuração.

SiteAuthSettings

Definições de configuração para a funcionalidade autenticação/autorização do Serviço de Aplicações do Azure.

Name Tipo Description
id

string

ID do Recurso.

kind

string

Tipo de recurso.

name

string

Nome do Recurso.

properties.aadClaimsAuthorization

string

Obtém uma cadeia JSON que contém as definições do Azure AD Acl.

properties.additionalLoginParams

string[]

Parâmetros de início de sessão para enviar para o ponto final de autorização do OpenID Connect quando um utilizador inicia sessão. Cada parâmetro tem de estar no formato "key=value".

properties.allowedAudiences

string[]

Permitiu que os valores de audiência considerassem ao validar os Tokens Web JSON emitidos pelo Azure Active Directory. Tenha em atenção que o ClientID valor é sempre considerado uma audiência permitida, independentemente desta definição.

properties.allowedExternalRedirectUrls

string[]

URLs externos para os quais pode ser redirecionado como parte do início de sessão ou de fim de sessão da aplicação. Tenha em atenção que a parte da cadeia de consulta do URL é ignorada. Normalmente, esta é uma definição avançada necessária apenas para back-ends de aplicações da Loja Windows. Tenha em atenção que os URLs dentro do domínio atual são sempre implicitamente permitidos.

properties.authFilePath

string

O caminho do ficheiro de configuração que contém as definições de autenticação. Se o caminho for relativo, a base será o diretório de raiz do site.

properties.clientId

string

O ID de Cliente desta aplicação de entidade confiadora, conhecida como client_id. Esta definição é necessária para ativar a autenticação da Ligação OpenID com o Azure Active Directory ou outros fornecedores 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 desta aplicação de entidade confiadora (no Azure Active Directory, também é conhecido como a Chave). Esta definição é opcional. Se não estiver configurado nenhum segredo do cliente, o fluxo de autenticação implícita do OpenID Connect é utilizado para autenticar os utilizadores finais. Caso contrário, o Fluxo de Código de Autorização do OpenID Connect é utilizado para autenticar os utilizadores 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 é o thumbprint de um certificado utilizado para fins de assinatura. Esta propriedade atua como um substituto do Segredo do Cliente. Também é opcional.

properties.clientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente da aplicação da entidade confiadora.

properties.configVersion

string

A ConfigVersion da funcionalidade Autenticação/Autorização em utilização para a aplicação atual. A definição neste valor pode controlar o comportamento do plano de controlo para Autenticação/Autorização.

properties.defaultProvider

BuiltInAuthenticationProvider

O fornecedor de autenticação predefinido a utilizar quando vários fornecedores estão configurados. Esta definição só é necessária se vários fornecedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

properties.enabled

boolean

true se a funcionalidade Autenticação/Autorização estiver ativada para a aplicação atual; caso contrário, false.

properties.facebookAppId

string

O ID da Aplicação da aplicação Facebook utilizada para iniciar sessão. Esta definição é necessária para ativar Facebook Início de Sessão. Facebook Documentação de início de sessão:https://developers.facebook.com/docs/facebook-login

properties.facebookAppSecret

string

O Segredo da Aplicação da aplicação Facebook utilizada para Facebook Início de Sessão. Esta definição é necessária para ativar Facebook Início de Sessão. Facebook Documentação de início de sessão:https://developers.facebook.com/docs/facebook-login

properties.facebookAppSecretSettingName

string

O nome da definição da aplicação que contém o segredo da aplicação utilizado para Facebook Início de Sessão.

properties.facebookOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação de Início de Sessão do Facebook. Esta definição é opcional. Facebook Documentação de início de sessão:https://developers.facebook.com/docs/facebook-login

properties.gitHubClientId

string

O ID de Cliente da aplicação GitHub utilizada para iniciar sessão. Esta definição é necessária para ativar o início de sessão no Github

properties.gitHubClientSecret

string

O Segredo do Cliente da aplicação GitHub utilizada para o Início de Sessão do Github. Esta definição é necessária para ativar o início de sessão do Github.

properties.gitHubClientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente da aplicação Github utilizada para o Início de Sessão do GitHub.

properties.gitHubOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação de Início de Sessão do GitHub. Esta definição é opcional

properties.googleClientId

string

O ID de Cliente do OpenID Connect para a aplicação Web da Google. Esta definição é necessária para ativar o Início de Sessão do Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.googleClientSecret

string

O segredo do cliente associado à aplicação Web google. Esta definição é necessária para ativar o Início de Sessão do Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.googleClientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente associado à aplicação Web google.

properties.googleOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação do Google Sign-In. Esta definição é opcional. Se não for especificado, "openid", "profile" e "email" são utilizados como âmbitos predefinidos. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.isAuthFromFile

string

"true" se as definições de configuração de autenticação devem ser lidas a partir de um ficheiro, caso contrário, "falso"

properties.issuer

string

O URI do Emissor do OpenID Connect que representa a entidade que emite tokens de acesso para esta aplicação. Ao utilizar o Azure Active Directory, este valor é o URI do inquilino do diretório, por exemplo, https://sts.windows.net/{tenant-guid}/. Este URI é um identificador sensível às maiúsculas e minúsculas do emissor do token. Mais informações sobre a Deteção do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

properties.microsoftAccountClientId

string

O ID de cliente OAuth 2.0 que foi criado para a aplicação utilizada para autenticação. Esta definição é necessária para ativar a autenticação da Conta Microsoft. Documentação do OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm

properties.microsoftAccountClientSecret

string

O segredo do cliente OAuth 2.0 que foi criado para a aplicação utilizada para autenticação. Esta definição é necessária para ativar a autenticação da Conta Microsoft. Documentação do OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm

properties.microsoftAccountClientSecretSettingName

string

O nome da definição da aplicação que contém o segredo do cliente OAuth 2.0 que foi criado para a aplicação utilizada para autenticação.

properties.microsoftAccountOAuthScopes

string[]

Os âmbitos do OAuth 2.0 que serão pedidos como parte da autenticação da Conta Microsoft. Esta definição é opcional. Se não for especificado, "wl.basic" é utilizado como o âmbito predefinido. Documentação de Âmbitos e permissões da Conta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx

properties.runtimeVersion

string

A RuntimeVersion da funcionalidade Autenticação/Autorização em utilização para a aplicação atual. A definição neste valor pode controlar o comportamento de determinadas funcionalidades 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 utilizado para chamar a API de atualização de tokens. A predefinição são 72 horas.

properties.tokenStoreEnabled

boolean

true para armazenar de forma duradoura tokens de segurança específicos da plataforma que são obtidos durante os fluxos de início de sessão; caso contrário, false. A predefinição é false.

properties.twitterConsumerKey

string

A chave de consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão. Esta definição é necessária para ativar o Início de Sessão no Twitter. Documentação de Sign-In do Twitter: https://dev.twitter.com/web/sign-in

properties.twitterConsumerSecret

string

O segredo do consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão. Esta definição é necessária para ativar o Início de Sessão no Twitter. Documentação de Sign-In do Twitter: https://dev.twitter.com/web/sign-in

properties.twitterConsumerSecretSettingName

string

O nome da definição da aplicação que contém o segredo de consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão.

properties.unauthenticatedClientAction

UnauthenticatedClientAction

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

properties.validateIssuer

boolean

Obtém um valor que indica se o emissor deve ser um URL HTTPS válido e ser validado como tal.

type

string

Tipo de recurso.

UnauthenticatedClientAction

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

Name Tipo Description
AllowAnonymous

string

RedirectToLoginPage

string