SiteAuthSettings interface

Pacote:

@azure/arm-appservice

Configurações para o recurso autenticação/autorização do Serviço de Aplicativo do Azure.

Extends

ProxyOnlyResource

Propriedades

aadClaimsAuthorization	Obtém uma cadeia de caracteres JSON que contém as configurações de Acl do Azure AD.
additionalLoginParams	Parâmetros de logon para enviar ao ponto de extremidade de autorização do OpenID Connect quando um usuário faz logon. Cada parâmetro deve estar no formato "key=value".
allowedAudiences	Permitiu que os valores de audiência considerassem ao validar tokens Web JSON emitidos pelo Azure Active Directory. Observe que o valor ClientID é sempre considerado um público-alvo permitido, independentemente dessa configuração.
allowedExternalRedirectUrls	URLs externas que podem ser redirecionadas como parte do logon ou do registro em log 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.
authFilePath	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.
clientId	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
clientSecret	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
clientSecretCertificateThumbprint	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.
clientSecretSettingName	O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável.
configVersion	A ConfigVersion do recurso autenticação/autorização em uso para o aplicativo atual. A configuração nesse valor pode controlar o comportamento do plano de controle para Autenticação/Autorização.
defaultProvider	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".
enabled	true se o recurso autenticação/autorização estiver habilitado para o aplicativo atual; caso contrário, false.
facebookAppId	A ID do aplicativo do Facebook usada para logon. Essa configuração é necessária para habilitar o Logon do Facebook. Documentação de logon do Facebook: https://developers.facebook.com/docs/facebook-login
facebookAppSecret	O Segredo do Aplicativo do aplicativo facebook usado para logon do Facebook. Essa configuração é necessária para habilitar o Logon do Facebook. Documentação de logon do Facebook: https://developers.facebook.com/docs/facebook-login
facebookAppSecretSettingName	O nome da configuração do aplicativo que contém o segredo do aplicativo usado para o Logon do Facebook.
facebookOAuthScopes	Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do Facebook. Essa configuração é opcional. Documentação de logon do Facebook: https://developers.facebook.com/docs/facebook-login
gitHubClientId	A ID do cliente do aplicativo GitHub usada para logon. Essa configuração é necessária para habilitar o logon do Github
gitHubClientSecret	O Segredo do Cliente do aplicativo GitHub usado para o Logon do Github. Essa configuração é necessária para habilitar o logon do Github.
gitHubClientSecretSettingName	O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para o Logon do GitHub.
gitHubOAuthScopes	Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do GitHub. Essa configuração é opcional
googleClientId	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/
googleClientSecret	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/
googleClientSecretSettingName	O nome da configuração do aplicativo que contém o segredo do cliente associado ao aplicativo Web do Google.
googleOAuthScopes	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/
isAuthFromFile	"true" se as configurações de configuração de autenticação devem ser lidas de um arquivo, "false" caso contrário
issuer	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
microsoftAccountClientId	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 Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecret	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 Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm
microsoftAccountClientSecretSettingName	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.
microsoftAccountOAuthScopes	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
runtimeVersion	O runtimeVersion do recurso 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.
tokenRefreshExtensionHours	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 é 72 horas.
tokenStoreEnabled	true armazenar tokens de segurança específicos da plataforma que são obtidos durante os fluxos de logon; caso contrário, false. O padrão é false.
twitterConsumerKey	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 da Sign-In do Twitter: https://dev.twitter.com/web/sign-in
twitterConsumerSecret	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 da Sign-In do Twitter: https://dev.twitter.com/web/sign-in
twitterConsumerSecretSettingName	O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo twitter usado para entrar.
unauthenticatedClientAction	A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.
validateIssuer	Obtém um valor que indica se o emissor deve ser uma URL HTTPS válida e ser validado como tal.

Propriedades herdadas

id	ID do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
kind	Tipo de recurso.
name	Nome do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type	Tipo de recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

aadClaimsAuthorization

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

aadClaimsAuthorization?: string

Valor da propriedade

string

additionalLoginParams

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

additionalLoginParams?: string[]

Valor da propriedade

string[]

allowedAudiences

Permitiu que os valores de audiência considerassem ao validar tokens Web JSON emitidos pelo Azure Active Directory. Observe que o valor ClientID é sempre considerado um público-alvo permitido, independentemente dessa configuração.

allowedAudiences?: string[]

Valor da propriedade

string[]

allowedExternalRedirectUrls

URLs externas que podem ser redirecionadas como parte do logon ou do registro em log 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.

allowedExternalRedirectUrls?: string[]

Valor da propriedade

string[]

authFilePath

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.

authFilePath?: string

Valor da propriedade

string

clientId

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

clientId?: string

Valor da propriedade

string

clientSecret

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

clientSecret?: string

Valor da propriedade

string

clientSecretCertificateThumbprint

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.

clientSecretCertificateThumbprint?: string

Valor da propriedade

string

clientSecretSettingName

O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável.

clientSecretSettingName?: string

Valor da propriedade

string

configVersion

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

configVersion?: string

Valor da propriedade

string

defaultProvider

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

defaultProvider?: BuiltInAuthenticationProvider

Valor da propriedade

BuiltInAuthenticationProvider

enabled

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

enabled?: boolean

Valor da propriedade

boolean

facebookAppId

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

facebookAppId?: string

Valor da propriedade

string

facebookAppSecret

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

facebookAppSecret?: string

Valor da propriedade

string

facebookAppSecretSettingName

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

facebookAppSecretSettingName?: string

Valor da propriedade

string

facebookOAuthScopes

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

facebookOAuthScopes?: string[]

Valor da propriedade

string[]

gitHubClientId

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

gitHubClientId?: string

Valor da propriedade

string

gitHubClientSecret

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

gitHubClientSecret?: string

Valor da propriedade

string

gitHubClientSecretSettingName

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

gitHubClientSecretSettingName?: string

Valor da propriedade

string

gitHubOAuthScopes

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

gitHubOAuthScopes?: string[]

Valor da propriedade

string[]

googleClientId

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/

googleClientId?: string

Valor da propriedade

string

googleClientSecret

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/

googleClientSecret?: string

Valor da propriedade

string

googleClientSecretSettingName

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

googleClientSecretSettingName?: string

Valor da propriedade

string

googleOAuthScopes

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/

googleOAuthScopes?: string[]

Valor da propriedade

string[]

isAuthFromFile

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

isAuthFromFile?: string

Valor da propriedade

string

issuer

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

issuer?: string

Valor da propriedade

string

microsoftAccountClientId

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 Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientId?: string

Valor da propriedade

string

microsoftAccountClientSecret

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 Microsoft Account OAuth: https://dev.onedrive.com/auth/msa_oauth.htm

microsoftAccountClientSecret?: string

Valor da propriedade

string

microsoftAccountClientSecretSettingName

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.

microsoftAccountClientSecretSettingName?: string

Valor da propriedade

string

microsoftAccountOAuthScopes

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

microsoftAccountOAuthScopes?: string[]

Valor da propriedade

string[]

runtimeVersion

O runtimeVersion do recurso 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.

runtimeVersion?: string

Valor da propriedade

string

tokenRefreshExtensionHours

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 é 72 horas.

tokenRefreshExtensionHours?: number

Valor da propriedade

number

tokenStoreEnabled

true armazenar tokens de segurança específicos da plataforma que são obtidos durante os fluxos de logon; caso contrário, false. O padrão é false.

tokenStoreEnabled?: boolean

Valor da propriedade

boolean

twitterConsumerKey

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 da Sign-In do Twitter: https://dev.twitter.com/web/sign-in

twitterConsumerKey?: string

Valor da propriedade

string

twitterConsumerSecret

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 da Sign-In do Twitter: https://dev.twitter.com/web/sign-in

twitterConsumerSecret?: string

Valor da propriedade

string

twitterConsumerSecretSettingName

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

twitterConsumerSecretSettingName?: string

Valor da propriedade

string

unauthenticatedClientAction

A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.

unauthenticatedClientAction?: UnauthenticatedClientAction

Valor da propriedade

UnauthenticatedClientAction

validateIssuer

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

validateIssuer?: boolean

Valor da propriedade

boolean

Detalhes das propriedades herdadas

id

ID do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

herdado deProxyOnlyResource.id

kind

Tipo de recurso.

kind?: string

Valor da propriedade

string

herdado deproxyOnlyResource.kind

name

Nome do recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

herdado deProxyOnlyResource.name

type

Tipo de recurso. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deProxyOnlyResource.type