Sdílet prostřednictvím

InteractiveBrowserCredentialNodeOptions interface

  • Reference
Balíček:
@azure/identity

Definuje společné možnosti interactiveBrowserCredential třídy.

Extends

InteractiveCredentialOptions,CredentialPersistenceOptions,BrowserCustomizationOptions,BrokerAuthOptions

Vlastnosti

clientId

ID klienta (aplikace) registrace aplikace v tenantovi.
loginHint

loginHint umožňuje předem vybrat uživatelské jméno pro interaktivní přihlášení. Nastavení této možnosti přeskočí výzvu k výběru účtu a okamžitě se pokusí přihlásit pomocí zadaného účtu.
redirectUri

Získá identifikátor URI přesměrování aplikace. Tato hodnota by měla být stejná jako hodnota na portálu pro registraci aplikací. Výchozí hodnota je window.location.href. Toto pole už není pro Node.js potřeba.
tenantId

ID tenanta (adresáře) Microsoft Entra.

Zděděné vlastnosti

additionallyAllowedTenants

U aplikací s více tenanty určuje další tenanty, pro které přihlašovací údaje můžou získat tokeny. Přidejte hodnotu se zástupným znakem "*", aby přihlašovací údaje mohly získávat tokeny pro všechny tenanty, ve které je aplikace nainstalovaná.
additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.
allowInsecureConnection

Pokud se požadavek odesílá přes HTTP místo HTTPS, nastavte hodnotu true.
authenticationRecord

Výsledek předchozího ověření, který lze použít k načtení přihlašovacích údajů uložených v mezipaměti každého jednotlivého účtu. To je nezbytné pro případ, že aplikace chce pracovat s více než jedním účtem pro každou dvojici ID klienta a ID tenanta.

Tento záznam je možné načíst voláním metody přihlašovacích údajů authenticate() následujícím způsobem:

const authenticationRecord = await credential.authenticate();
authorityHost

Hostitel autority, který se má použít pro žádosti o ověření. Možné hodnoty jsou k dispozici prostřednictvím AzureAuthorityHosts. Výchozí hodnota je "https://login.microsoftonline.com".
brokerOptions

Možnosti pro povolení ověřování zprostředkovatele při použití InteractiveBrowserCredential
browserCustomizationOptions

Možnosti sdílené konfigurace pro přizpůsobení prohlížeče
disableAutomaticAuthentication

Pokud je potřeba ruční ověření, vyvolá getToken. Vývojáři budou muset zavolat na , authenticate() aby mohli určit, kdy se mají ručně ověřit.
disableInstanceDiscovery

Pole určuje, jestli se při pokusu o ověření provede zjišťování instancí. Nastavením této možnosti na true úplně zakážete zjišťování instancí i ověřování autorit. Proto je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný. Tato funkce je určená pro použití ve scénářích, kdy není dostupný koncový bod metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instance zahrnuje načtení metadat autority z, https://login.microsoft.com/ aby se autorita ověřila.
httpClient

HttpClient, který se použije k odesílání požadavků HTTP.
loggingOptions

Umožňuje uživatelům konfigurovat nastavení pro možnosti zásad protokolování, povolit protokolování informací o účtu a identifikovatelné osobní údaje pro zákaznickou podporu.
proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky
redirectOptions

Možnosti zpracování odpovědí přesměrování
retryOptions

Možnosti, které určují, jak opakovat neúspěšné žádosti.
telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky
tlsOptions

Možnosti konfigurace ověřování TLS
tokenCachePersistenceOptions

Možnosti, které se mají poskytnout vrstvě trvalosti (pokud je k dispozici) při ukládání přihlašovacích údajů

Nejprve musíte zaregistrovat modul plug-in poskytovatele trvalosti. Viz balíček na @azure/identity-cache-persistence NPM.

Příklad:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});
userAgentOptions

Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

Podrobnosti vlastnosti

clientId

ID klienta (aplikace) registrace aplikace v tenantovi.

clientId?: string

Hodnota vlastnosti

string

loginHint

loginHint umožňuje předem vybrat uživatelské jméno pro interaktivní přihlášení. Nastavení této možnosti přeskočí výzvu k výběru účtu a okamžitě se pokusí přihlásit pomocí zadaného účtu.

loginHint?: string

Hodnota vlastnosti

string

redirectUri

Získá identifikátor URI přesměrování aplikace. Tato hodnota by měla být stejná jako hodnota na portálu pro registraci aplikací. Výchozí hodnota je window.location.href. Toto pole už není pro Node.js potřeba.

redirectUri?: string | () => string

Hodnota vlastnosti

string | () => string

tenantId

ID tenanta (adresáře) Microsoft Entra.

tenantId?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

additionallyAllowedTenants

U aplikací s více tenanty určuje další tenanty, pro které přihlašovací údaje můžou získat tokeny. Přidejte hodnotu se zástupným znakem "*", aby přihlašovací údaje mohly získávat tokeny pro všechny tenanty, ve které je aplikace nainstalovaná.

additionallyAllowedTenants?: string[]

Hodnota vlastnosti

string[]

Zděděno zInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Další zásady, které se mají zahrnout do kanálu HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Hodnota vlastnosti

AdditionalPolicyConfig[]

Zděděno zInteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Pokud se požadavek odesílá přes HTTP místo HTTPS, nastavte hodnotu true.

allowInsecureConnection?: boolean

Hodnota vlastnosti

boolean

Zděděno zInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Výsledek předchozího ověření, který lze použít k načtení přihlašovacích údajů uložených v mezipaměti každého jednotlivého účtu. To je nezbytné pro případ, že aplikace chce pracovat s více než jedním účtem pro každou dvojici ID klienta a ID tenanta.

Tento záznam je možné načíst voláním metody přihlašovacích údajů authenticate() následujícím způsobem:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Hodnota vlastnosti

AuthenticationRecord

Zděděno zInteractiveCredentialOptions.authenticationRecord

authorityHost

Hostitel autority, který se má použít pro žádosti o ověření. Možné hodnoty jsou k dispozici prostřednictvím AzureAuthorityHosts. Výchozí hodnota je "https://login.microsoftonline.com".

authorityHost?: string

Hodnota vlastnosti

string

Zděděno zInteractiveCredentialOptions.authorityHost

brokerOptions

Možnosti pro povolení ověřování zprostředkovatele při použití InteractiveBrowserCredential

brokerOptions?: BrokerOptions

Hodnota vlastnosti

BrokerOptions

Zděděno zBrokerAuthOptions.brokerOptions

browserCustomizationOptions

Možnosti sdílené konfigurace pro přizpůsobení prohlížeče

browserCustomizationOptions?: { errorMessage?: string, successMessage?: string }

Hodnota vlastnosti

{ errorMessage?: string, successMessage?: string }

Zděděno zprohlížečeCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

Pokud je potřeba ruční ověření, vyvolá getToken. Vývojáři budou muset zavolat na , authenticate() aby mohli určit, kdy se mají ručně ověřit.

disableAutomaticAuthentication?: boolean

Hodnota vlastnosti

boolean

Zděděno zInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Pole určuje, jestli se při pokusu o ověření provede zjišťování instancí. Nastavením této možnosti na true úplně zakážete zjišťování instancí i ověřování autorit. Proto je důležité zajistit, aby nakonfigurovaný hostitel autority byl platný a důvěryhodný. Tato funkce je určená pro použití ve scénářích, kdy není dostupný koncový bod metadat, například v privátních cloudech nebo ve službě Azure Stack. Proces zjišťování instance zahrnuje načtení metadat autority z, https://login.microsoft.com/ aby se autorita ověřila.

disableInstanceDiscovery?: boolean

Hodnota vlastnosti

boolean

Zděděno zInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient, který se použije k odesílání požadavků HTTP.

httpClient?: HttpClient

Hodnota vlastnosti

HttpClient

Zděděno zInteractiveCredentialOptions.httpClient

loggingOptions

Umožňuje uživatelům konfigurovat nastavení pro možnosti zásad protokolování, povolit protokolování informací o účtu a identifikovatelné osobní údaje pro zákaznickou podporu.

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

Hodnota vlastnosti

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

Zděděno zInteractiveCredentialOptions.loggingOptions

proxyOptions

Možnosti konfigurace proxy serveru pro odchozí požadavky

proxyOptions?: ProxySettings

Hodnota vlastnosti

ProxySettings

Zděděno zInteractiveCredentialOptions.proxyOptions

redirectOptions

Možnosti zpracování odpovědí přesměrování

redirectOptions?: RedirectPolicyOptions

Hodnota vlastnosti

RedirectPolicyOptions

Zděděno zInteractiveCredentialOptions.redirectOptions

retryOptions

Možnosti, které určují, jak opakovat neúspěšné žádosti.

retryOptions?: PipelineRetryOptions

Hodnota vlastnosti

PipelineRetryOptions

Zděděno zInteractiveCredentialOptions.retryOptions

telemetryOptions

Možnosti nastavení běžné telemetrie a trasování informací pro odchozí požadavky

telemetryOptions?: TelemetryOptions

Hodnota vlastnosti

TelemetryOptions

Zděděno zInteractiveCredentialOptions.telemetryOptions

tlsOptions

Možnosti konfigurace ověřování TLS

tlsOptions?: TlsSettings

Hodnota vlastnosti

TlsSettings

Zděděno zInteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Možnosti, které se mají poskytnout vrstvě trvalosti (pokud je k dispozici) při ukládání přihlašovacích údajů

Nejprve musíte zaregistrovat modul plug-in poskytovatele trvalosti. Viz balíček na @azure/identity-cache-persistence NPM.

Příklad:

import { cachePersistencePlugin } from "@azure/identity-cache-persistence";
import { useIdentityPlugin, DeviceCodeCredential } from "@azure/identity";

useIdentityPlugin(cachePersistencePlugin);

async function main() {
  const credential = new DeviceCodeCredential({
    tokenCachePersistenceOptions: {
      enabled: true
    }
  });
}

main().catch((error) => {
  console.error("An error occurred:", error);
  process.exit(1);
});

tokenCachePersistenceOptions?: TokenCachePersistenceOptions

Hodnota vlastnosti

TokenCachePersistenceOptions

Zděděno zCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Možnosti pro přidání podrobností o uživatelském agentu k odchozím požadavkům

userAgentOptions?: UserAgentPolicyOptions

Hodnota vlastnosti

UserAgentPolicyOptions

Zděděno zInteractiveCredentialOptions.userAgentOptions