Compartilhar via


SiteAuthSettings Classe

Configurações do recurso Serviço de Aplicativo do Azure Autenticação/Autorização.

As variáveis são preenchidas apenas pelo servidor e serão ignoradas ao enviar uma solicitação.

Herança
azure.mgmt.web.v2023_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 somente de palavra-chave

Nome Description
kind
str

Tipo de recurso.

enabled

<code>true</code> se o recurso autenticação/autorização estiver habilitado para o aplicativo atual; caso contrário, <code>false</code>.

runtime_version
str

O RuntimeVersion do recurso de Autenticação/Autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento de determinados recursos no módulo Autenticação/Autorização.

unauthenticated_client_action

A ação a ser tomada quando um cliente não autenticado tenta acessar o aplicativo. Os valores conhecidos são: "RedirectToLoginPage" e "AllowAnonymous".

token_store_enabled

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

O padrão é <code>false</code>.

allowed_external_redirect_urls

URLs externas que podem ser redirecionadas para como parte do logon ou do logon do aplicativo. Observe que a parte da cadeia de caracteres de consulta da URL é ignorada. Essa é uma configuração avançada normalmente necessária apenas para back-ends de aplicativos da Windows Store. Observe que as URLs dentro do domínio atual são sempre permitidas implicitamente.

default_provider

O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só será necessária se vários provedores estiverem configurados e a ação de cliente não autenticada for 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 usado para chamar a API de atualização de token. O padrão é de 72 horas.

client_id
str

A ID do cliente desse aplicativo de terceira parte confiável, conhecida como client_id. Essa configuração é necessária para habilitar a autenticação de Conexão OpenID com o Azure Active Directory ou outros provedores do 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 desse aplicativo de terceira parte confiável (no Azure Active Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícita do OpenID Connect será usado para autenticar os usuários finais. Caso contrário, o Fluxo de Código de Autorização do OpenID Connect será usado para autenticar usuários 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 configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável.

client_secret_certificate_thumbprint
str

Uma alternativa ao segredo do cliente, que é a impressão digital de um certificado usado para fins de assinatura. Essa propriedade atua como uma substituição para o 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 este aplicativo. Ao usar o Azure Active Directory, esse valor é o URI do locatário do diretório, por exemplo https://sts.windows.net, /{tenant-guid}/. Esse URI é um identificador que diferencia maiúsculas de minúsculas para o emissor do token. Mais informações sobre a Descoberta 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 uma URL HTTPS válida e ser validado como tal.

allowed_audiences

Os valores de audiência permitidos a serem considerados ao validar tokens Web JSON emitidos pelo Azure Active Directory. Observe que o <code>ClientID</code> valor é sempre considerado um público-alvo permitido, independentemente dessa configuração.

additional_login_params

Parâmetros de logon para enviar para o ponto de extremidade de autorização do OpenID Connect quando um usuário faz logon. Cada parâmetro deve estar no formato "key=value".

aad_claims_authorization
str

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

google_client_id
str

A ID do cliente do OpenID Connect para o aplicativo Web do Google. Essa configuração é necessária para habilitar a Entrada 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 ao aplicativo Web do Google. Essa configuração é necessária para habilitar a Entrada 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 configuração do aplicativo que contém o segredo do cliente associado ao aplicativo Web do Google.

google_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação do Google Sign-In. Essa configuração é opcional. Se não for especificado, "openid", "profile" e "email" serão usados como escopos padrão. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/.

facebook_app_id
str

A ID do aplicativo do Facebook usado para logon. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret
str

O Segredo do Aplicativo do aplicativo Facebook usado para logon Facebook. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do aplicativo usado para Facebook Logon.

facebook_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do Facebook. Essa configuração é opcional. Facebook documentação de logon: https://developers.facebook.com/docs/facebook-login.

git_hub_client_id
str

A ID do cliente do aplicativo GitHub usado para logon. Essa configuração é necessária para habilitar o logon do Github.

git_hub_client_secret
str

O Segredo do Cliente do aplicativo GitHub usado para o Logon do Github. Essa configuração é necessária para habilitar o logon do Github.

git_hub_client_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para o Logon do GitHub.

git_hub_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do GitHub. Essa configuração é opcional.

twitter_consumer_key
str

A chave do consumidor OAuth 1.0a do aplicativo twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret
str

O segredo do consumidor OAuth 1.0a do aplicativo twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo twitter usado para entrar.

microsoft_account_client_id
str

A ID do cliente OAuth 2.0 que foi criada para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação de Conta da Microsoft. Documentação do Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret
str

O segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação de Conta da Microsoft. Documentação do Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação.

microsoft_account_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação da Conta da Microsoft. Essa configuração é opcional. Se não for especificado, "wl.basic" será usado como o escopo padrão. Documentação de Escopos e permissões da Conta microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx.

is_auth_from_file
str

"true" se as configurações de autenticação devem ser lidas de um arquivo, caso contrário, "false".

auth_file_path
str

O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, baseará o diretório raiz do site.

config_version
str

A ConfigVersion do recurso de Autenticação/Autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento do painel de controle para Autenticação/Autorização.

Variáveis

Nome 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 o recurso autenticação/autorização estiver habilitado para o aplicativo atual; caso contrário, <code>false</code>.

runtime_version
str

O RuntimeVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento de determinados recursos no módulo Autenticação/Autorização.

unauthenticated_client_action

A ação a ser tomada quando um cliente não autenticado tenta acessar o aplicativo. Os valores conhecidos são: "RedirectToLoginPage" e "AllowAnonymous".

token_store_enabled

<code>true</code> para armazenar permanentemente tokens de segurança específicos da plataforma obtidos durante os fluxos de logon; caso contrário, <code>false</code>.

O padrão é <code>false</code>.

allowed_external_redirect_urls

URLs externas que podem ser redirecionadas para como parte do logon ou logoff do aplicativo. Observe que a parte da cadeia de caracteres de consulta da URL é ignorada. Essa é uma configuração avançada normalmente necessária apenas para back-ends de aplicativos da Windows Store. Observe que as URLs dentro do domínio atual são sempre implicitamente permitidas.

default_provider

O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só será necessária se vários provedores 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 usado para chamar a API de atualização de token. O padrão é de 72 horas.

client_id
str

A ID do cliente desse aplicativo de terceira parte confiável, conhecida como client_id. Essa configuração é necessária para habilitar a autenticação de Conexão OpenID com o Azure Active Directory ou outros provedores do 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 desse aplicativo de terceira parte confiável (no Azure Active Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícita do OpenID Connect será usado para autenticar os usuários finais. Caso contrário, o Fluxo de Código de Autorização do OpenID Connect será usado para autenticar os usuários 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 configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável.

client_secret_certificate_thumbprint
str

Uma alternativa ao segredo do cliente, que é a impressão digital de um certificado usado para fins de assinatura. Essa propriedade atua como uma substituição para o 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 este aplicativo. Ao usar o Azure Active Directory, esse valor é o URI do locatário do diretório, por exemplo https://sts.windows.net, /{tenant-guid}/. Esse URI é um identificador que diferencia maiúsculas de minúsculas para o emissor do token. Mais informações sobre a Descoberta 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 uma URL HTTPS válida e ser validado como tal.

allowed_audiences

Valores de audiência permitidos a serem considerados ao validar tokens Web JSON emitidos pelo Azure Active Directory. Observe que o <code>ClientID</code> valor é sempre considerado um público-alvo permitido, independentemente dessa configuração.

additional_login_params

Parâmetros de logon a serem enviados para o ponto de extremidade de autorização do OpenID Connect quando um usuário fizer logon. Cada parâmetro deve estar no formato "key=value".

aad_claims_authorization
str

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

google_client_id
str

A ID do cliente do OpenID Connect para o aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada no Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/.

google_client_secret
str

O segredo do cliente associado ao aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada no Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/.

google_client_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do cliente associado ao aplicativo Web do Google.

google_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação do Google Sign-In. Essa configuração é opcional. Se não for especificado, "openid", "profile" e "email" serão usados como escopos padrão. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/.

facebook_app_id
str

A ID do aplicativo do Facebook usado para logon. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret
str

O Segredo do Aplicativo do aplicativo Facebook usado para logon Facebook. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon: https://developers.facebook.com/docs/facebook-login.

facebook_app_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do aplicativo usado para Facebook Logon.

facebook_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do Facebook. Essa configuração é opcional. Facebook documentação de logon: https://developers.facebook.com/docs/facebook-login.

git_hub_client_id
str

A ID do cliente do aplicativo GitHub usada para logon. Essa configuração é necessária para habilitar o logon do Github.

git_hub_client_secret
str

O Segredo do Cliente do aplicativo GitHub usado para logon do Github. Essa configuração é necessária para habilitar o logon do Github.

git_hub_client_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para logon do GitHub.

git_hub_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do GitHub. Essa configuração é opcional.

twitter_consumer_key
str

A chave do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret
str

O segredo do consumidor do OAuth 1.0a do aplicativo do Twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in.

twitter_consumer_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar.

microsoft_account_client_id
str

A ID do cliente OAuth 2.0 que foi criada para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação do OAuth da Conta da 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 o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação do OAuth da Conta da Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm.

microsoft_account_client_secret_setting_name
str

O nome da configuração do aplicativo que contém o segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação.

microsoft_account_o_auth_scopes

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação da Conta da Microsoft. Essa configuração é opcional. Se não for especificado, "wl.basic" será usado como o escopo padrão. Documentação de escopos e permissões de conta da Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx.

is_auth_from_file
str

"true" se as configurações de autenticação devem ser lidas de um arquivo, caso contrário, "false".

auth_file_path
str

O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, baseará o diretório raiz do site.

config_version
str

O ConfigVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento do painel de controle para Autenticação/Autorização.