Partilhar via


SiteAuthSettings Classe

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

As variáveis só são preenchidas pelo servidor e serão ignoradas ao enviar um pedido.

Herança
azure.mgmt.web.v2021_01_01.models._models_py3.ProxyOnlyResource
SiteAuthSettings

Construtor

SiteAuthSettings(*, kind: str | None = None, enabled: bool | None = None, runtime_version: str | None = None, unauthenticated_client_action: str | _models.UnauthenticatedClientAction | None = None, token_store_enabled: bool | None = None, allowed_external_redirect_urls: List[str] | None = None, default_provider: str | _models.BuiltInAuthenticationProvider | None = None, token_refresh_extension_hours: float | None = None, client_id: str | None = None, client_secret: str | None = None, client_secret_setting_name: str | None = None, client_secret_certificate_thumbprint: str | None = None, issuer: str | None = None, validate_issuer: bool | None = None, allowed_audiences: List[str] | None = None, additional_login_params: List[str] | None = None, aad_claims_authorization: str | None = None, google_client_id: str | None = None, google_client_secret: str | None = None, google_client_secret_setting_name: str | None = None, google_o_auth_scopes: List[str] | None = None, facebook_app_id: str | None = None, facebook_app_secret: str | None = None, facebook_app_secret_setting_name: str | None = None, facebook_o_auth_scopes: List[str] | None = None, git_hub_client_id: str | None = None, git_hub_client_secret: str | None = None, git_hub_client_secret_setting_name: str | None = None, git_hub_o_auth_scopes: List[str] | None = None, twitter_consumer_key: str | None = None, twitter_consumer_secret: str | None = None, twitter_consumer_secret_setting_name: str | None = None, microsoft_account_client_id: str | None = None, microsoft_account_client_secret: str | None = None, microsoft_account_client_secret_setting_name: str | None = None, microsoft_account_o_auth_scopes: List[str] | None = None, is_auth_from_file: str | None = None, auth_file_path: str | None = None, config_version: str | None = None, **kwargs: Any)

Parâmetros Só de Palavra-Chave

Name Description
kind
str

Tipo de recurso.

enabled

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

runtime_version
str

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.

unauthenticated_client_action

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação. Os valores conhecidos são: "RedirectToLoginPage" e "AllowAnonymous".

token_store_enabled

<code>true</code> para armazenar duravelmente tokens de segurança específicos da plataforma que são obtidos durante os fluxos de início de sessão; caso contrário, <code>false</code>.

A predefinição é <code>false</code>.

allowed_external_redirect_urls

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

default_provider

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". Os valores conhecidos são: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" e "Github".

token_refresh_extension_hours

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.

client_id
str

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 de OpenID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

client_secret
str

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.

client_secret_setting_name
str

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

client_secret_certificate_thumbprint
str

Uma alternativa ao segredo do cliente, que é o thumbprint de um certificado utilizado para fins de assinatura. Esta propriedade funciona como um substituto do Segredo do Cliente. Também é opcional.

issuer
str

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 de tokens. Mais informações sobre a Deteção do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html.

validate_issuer

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

allowed_audiences

Valores de audiência permitidos a considerar ao validar JWTs emitidos pelo Azure Active Directory. Tenha em atenção que o <code>ClientID</code> valor é sempre considerado uma audiência permitida, independentemente desta definição.

additional_login_params

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 formulário "key=value".

aad_claims_authorization
str

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

google_client_id
str

O ID de Cliente do OpenID Connect para a 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/.

google_client_secret
str

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

google_client_secret_setting_name
str

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

google_o_auth_scopes

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

facebook_app_id
str

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

facebook_app_secret
str

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

facebook_app_secret_setting_name
str

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

facebook_o_auth_scopes

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. Documentação de Início de Sessão do Facebook: https://developers.facebook.com/docs/facebook-login.

git_hub_client_id
str

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

git_hub_client_secret
str

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.

git_hub_client_secret_setting_name
str

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.

git_hub_o_auth_scopes

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.

twitter_consumer_key
str

A chave de consumidor OAuth 1.0a da aplicação twitter utilizada para o início de 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.

twitter_consumer_secret
str

O segredo do consumidor OAuth 1.0a da aplicação twitter utilizada para o início de 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.

twitter_consumer_secret_setting_name
str

O nome da definição da aplicação que contém o segredo do consumidor OAuth 1.0a da aplicação do Twitter utilizada para o início de sessão.

microsoft_account_client_id
str

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.

microsoft_account_client_secret
str

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.

microsoft_account_client_secret_setting_name
str

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.

microsoft_account_o_auth_scopes

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.

is_auth_from_file
str

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

auth_file_path
str

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 raiz do site.

config_version
str

A funcionalidade ConfigVersion da 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.

Variáveis

Name Description
id
str

ID do Recurso.

name
str

Nome do Recurso.

kind
str

Tipo de recurso.

type
str

Tipo de recurso.

enabled

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

runtime_version
str

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.

unauthenticated_client_action

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação. Os valores conhecidos são: "RedirectToLoginPage" e "AllowAnonymous".

token_store_enabled

<code>true</code> para armazenar duravelmente tokens de segurança específicos da plataforma que são obtidos durante os fluxos de início de sessão; caso contrário, <code>false</code>.

A predefinição é <code>false</code>.

allowed_external_redirect_urls

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

default_provider

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". Os valores conhecidos são: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter" e "Github".

token_refresh_extension_hours

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.

client_id
str

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 de OpenID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.

client_secret
str

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.

client_secret_setting_name
str

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

client_secret_certificate_thumbprint
str

Uma alternativa ao segredo do cliente, que é o thumbprint de um certificado utilizado para fins de assinatura. Esta propriedade funciona como um substituto do Segredo do Cliente. Também é opcional.

issuer
str

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 de tokens. Mais informações sobre a Deteção do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html.

validate_issuer

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

allowed_audiences

Valores de audiência permitidos a considerar ao validar JWTs emitidos pelo Azure Active Directory. Tenha em atenção que o <code>ClientID</code> valor é sempre considerado uma audiência permitida, independentemente desta definição.

additional_login_params

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 formulário "key=value".

aad_claims_authorization
str

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

google_client_id
str

O ID de Cliente do OpenID Connect para a 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/.

google_client_secret
str

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

google_client_secret_setting_name
str

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

google_o_auth_scopes

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

facebook_app_id
str

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

facebook_app_secret
str

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

facebook_app_secret_setting_name
str

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

facebook_o_auth_scopes

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. Documentação de Início de Sessão do Facebook: https://developers.facebook.com/docs/facebook-login.

git_hub_client_id
str

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

git_hub_client_secret
str

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.

git_hub_client_secret_setting_name
str

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.

git_hub_o_auth_scopes

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.

twitter_consumer_key
str

A chave de consumidor OAuth 1.0a da aplicação twitter utilizada para o início de 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.

twitter_consumer_secret
str

O segredo do consumidor OAuth 1.0a da aplicação twitter utilizada para o início de 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.

twitter_consumer_secret_setting_name
str

O nome da definição da aplicação que contém o segredo do consumidor OAuth 1.0a da aplicação do Twitter utilizada para o início de sessão.

microsoft_account_client_id
str

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.

microsoft_account_client_secret
str

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.

microsoft_account_client_secret_setting_name
str

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.

microsoft_account_o_auth_scopes

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.

is_auth_from_file
str

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

auth_file_path
str

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 raiz do site.

config_version
str

A funcionalidade ConfigVersion da 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.