InteractiveBrowserCredentialInBrowserOptions interface

Pacote:

@azure/identity

Define as opções comuns para a classe InteractiveBrowserCredential.

Extends

InteractiveCredentialOptions

Propriedades

clientId	A ID do Cliente do aplicativo Microsoft Entra no qual os usuários entrarão. Este parâmetro é necessário no navegador. Os desenvolvedores precisam registrar seus aplicativos e atribuir funções apropriadas. Para mais informações, visite https://aka.ms/identity/AppRegistrationAndRoleAssignment.
loginHint	loginHint permite que um nome de usuário seja pré-selecionado para logins interativos. Definir esta opção ignora o prompt de seleção de conta e imediatamente tenta fazer login com a conta especificada.
loginStyle	Especifica se um redirecionamento ou uma janela pop-up deve ser usada para iniciar o fluxo de autenticação do usuário. Os valores possíveis são "redirecionamento" ou "popup" (padrão) para o navegador e "popup" (padrão) para o nó.
redirectUri	Obtém o URI de redirecionamento do aplicativo. Este valor deve ser igual ao do portal de registo da candidatura. O padrão é window.location.href. Este campo já não é obrigatório para Node.js.
tenantId	A ID do locatário (diretório) do Microsoft Entra.

Propriedades Herdadas

additionallyAllowedTenants	Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo esteja instalado.
additionalPolicies	Políticas adicionais a serem incluídas no pipeline HTTP.
agent	Opções para configurar a instância do Agente para solicitações de saída
allowInsecureConnection	Defina como true se a solicitação for enviada por HTTP em vez de HTTPS
authenticationRecord	Resultado de uma autenticação anterior que pode ser usada para recuperar as credenciais armazenadas em cache de cada conta individual. Isso é necessário para fornecer caso o aplicativo queira trabalhar com mais de uma conta por par de ID de Cliente e ID de Locatário. Esse registro pode ser recuperado chamando para o método authenticate() da credencial, da seguinte maneira: const authenticationRecord = await credential.authenticate();
authorityHost	O host de autoridade a ser usado para solicitações de autenticação. Os valores possíveis estão disponíveis por meio AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".
disableAutomaticAuthentication	Faz com que o getToken seja lançado se uma autenticação manual for necessária. Os desenvolvedores precisarão ligar para authenticate() para controlar quando autenticar manualmente.
disableInstanceDiscovery	O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desativará completamente a descoberta de instância e a validação de autoridade. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de https://login.microsoft.com/ autoridade para validar a autoridade.
httpClient	O HttpClient que será usado para enviar solicitações HTTP.
loggingOptions	Permite que os usuários configurem configurações para registrar opções de política, permitir o registro de informações de conta e informações de identificação pessoal para suporte ao cliente.
proxyOptions	Opções para configurar um proxy para solicitações de saída.
redirectOptions	Opções de como as respostas de redirecionamento são tratadas.
retryOptions	Opções que controlam como repetir solicitações com falha.
telemetryOptions	Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.
tlsOptions	Opções para configurar a autenticação TLS
userAgentOptions	Opções para adicionar detalhes do agente do usuário às solicitações de saída.

Detalhes de Propriedade

clientId

A ID do Cliente do aplicativo Microsoft Entra no qual os usuários entrarão. Este parâmetro é necessário no navegador. Os desenvolvedores precisam registrar seus aplicativos e atribuir funções apropriadas. Para mais informações, visite https://aka.ms/identity/AppRegistrationAndRoleAssignment.

clientId: string

Valor de Propriedade

string

loginHint

loginHint permite que um nome de usuário seja pré-selecionado para logins interativos. Definir esta opção ignora o prompt de seleção de conta e imediatamente tenta fazer login com a conta especificada.

loginHint?: string

Valor de Propriedade

string

loginStyle

Especifica se um redirecionamento ou uma janela pop-up deve ser usada para iniciar o fluxo de autenticação do usuário. Os valores possíveis são "redirecionamento" ou "popup" (padrão) para o navegador e "popup" (padrão) para o nó.

loginStyle?: BrowserLoginStyle

Valor de Propriedade

BrowserLoginStyle

redirectUri

Obtém o URI de redirecionamento do aplicativo. Este valor deve ser igual ao do portal de registo da candidatura. O padrão é window.location.href. Este campo já não é obrigatório para Node.js.

redirectUri?: string | () => string

Valor de Propriedade

string | () => string

tenantId

A ID do locatário (diretório) do Microsoft Entra.

tenantId?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

additionallyAllowedTenants

Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo esteja instalado.

additionallyAllowedTenants?: string[]

Valor de Propriedade

string[]

herdado deInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Políticas adicionais a serem incluídas no pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valor de Propriedade

AdditionalPolicyConfig[]

herdado deInteractiveCredentialOptions.additionalPolicies

agent

Opções para configurar a instância do Agente para solicitações de saída

agent?: Agent

Valor de Propriedade

Agent

herdado de InteractiveCredentialOptions.agent

allowInsecureConnection

Defina como true se a solicitação for enviada por HTTP em vez de HTTPS

allowInsecureConnection?: boolean

Valor de Propriedade

boolean

herdado de InteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Resultado de uma autenticação anterior que pode ser usada para recuperar as credenciais armazenadas em cache de cada conta individual. Isso é necessário para fornecer caso o aplicativo queira trabalhar com mais de uma conta por par de ID de Cliente e ID de Locatário.

Esse registro pode ser recuperado chamando para o método authenticate() da credencial, da seguinte maneira:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Valor de Propriedade

AuthenticationRecord

herdado de InteractiveCredentialOptions.authenticationRecord

authorityHost

O host de autoridade a ser usado para solicitações de autenticação. Os valores possíveis estão disponíveis por meio AzureAuthorityHosts. O padrão é "https://login.microsoftonline.com".

authorityHost?: string

Valor de Propriedade

string

herdado de InteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Faz com que o getToken seja lançado se uma autenticação manual for necessária. Os desenvolvedores precisarão ligar para authenticate() para controlar quando autenticar manualmente.

disableAutomaticAuthentication?: boolean

Valor de Propriedade

boolean

herdado de InteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

O campo determina se a descoberta de instância é executada ao tentar autenticar. Definir isso como true desativará completamente a descoberta de instância e a validação de autoridade. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de https://login.microsoft.com/ autoridade para validar a autoridade.

disableInstanceDiscovery?: boolean

Valor de Propriedade

boolean

herdado de InteractiveCredentialOptions.disableInstanceDiscovery

httpClient

O HttpClient que será usado para enviar solicitações HTTP.

httpClient?: HttpClient

Valor de Propriedade

HttpClient

herdado de InteractiveCredentialOptions.httpClient

loggingOptions

Permite que os usuários configurem configurações para registrar opções de política, permitir o registro de informações de conta e informações de identificação pessoal para suporte ao cliente.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Valor de Propriedade

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

herdado de InteractiveCredentialOptions.loggingOptions

proxyOptions

Opções para configurar um proxy para solicitações de saída.

proxyOptions?: ProxySettings

Valor de Propriedade

ProxySettings

herdado de InteractiveCredentialOptions.proxyOptions

redirectOptions

Opções de como as respostas de redirecionamento são tratadas.

redirectOptions?: RedirectPolicyOptions

Valor de Propriedade

RedirectPolicyOptions

herdado de InteractiveCredentialOptions.redirectOptions

retryOptions

Opções que controlam como repetir solicitações com falha.

retryOptions?: PipelineRetryOptions

Valor de Propriedade

PipelineRetryOptions

herdado de InteractiveCredentialOptions.retryOptions

telemetryOptions

Opções para definir informações comuns de telemetria e rastreamento para solicitações de saída.

telemetryOptions?: TelemetryOptions

Valor de Propriedade

TelemetryOptions

herdado deInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opções para configurar a autenticação TLS

tlsOptions?: TlsSettings

Valor de Propriedade

TlsSettings

herdado de InteractiveCredentialOptions.tlsOptions

userAgentOptions

Opções para adicionar detalhes do agente do usuário às solicitações de saída.

userAgentOptions?: UserAgentPolicyOptions

Valor de Propriedade

UserAgentPolicyOptions

herdado de InteractiveCredentialOptions.userAgentOptions