Partager via


InteractiveBrowserCredentialNodeOptions interface

Définit les options courantes pour la classe InteractiveBrowserCredential.

Extends

Propriétés

clientId

ID client (application) d’une inscription d’application dans le locataire.

loginHint

loginHint permet de pré-sélectionner un nom d’utilisateur pour les connexions interactives. La définition de cette option ignore l’invite de sélection du compte et tente immédiatement de se connecter avec le compte spécifié.

redirectUri

Obtient l’URI de redirection de l’application. Cette valeur doit être identique à la valeur dans le portail d’inscription d’application. La valeur par défaut est window.location.href. Ce champ n’est plus nécessaire pour Node.js.

tenantId

ID de locataire (répertoire) Microsoft Entra.

Propriétés héritées

additionallyAllowedTenants

Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire que l’application est installée.

additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.

allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS

authenticationRecord

Résultat d’une authentification précédente qui peut être utilisée pour récupérer les informations d’identification mises en cache de chaque compte individuel. Cela est nécessaire au cas où l’application souhaite utiliser plusieurs comptes par id client et id de locataire.

Cet enregistrement peut être récupéré en appelant la méthode des authenticate() informations d’identification, comme suit :

const authenticationRecord = await credential.authenticate();
authorityHost

Hôte d’autorité à utiliser pour les demandes d’authentification. Les valeurs possibles sont disponibles via AzureAuthorityHosts. La valeur par défaut est "https://login.microsoftonline.com".

brokerOptions

Options permettant d’autoriser l’authentification broker lors de l’utilisation d’InteractiveBrowserCredential

browserCustomizationOptions

Options de configuration partagée pour la personnalisation du navigateur

disableAutomaticAuthentication

Fait lever getToken si une authentification manuelle est nécessaire. Les développeurs devront appeler à authenticate() pour contrôler quand s’authentifier manuellement.

disableInstanceDiscovery

Le champ détermine si instance détection est effectuée lors de la tentative d’authentification. La définition de true cette valeur désactive complètement la découverte instance et la validation de l’autorité. Par conséquent, il est essentiel de s’assurer que l’hôte d’autorité configuré est valide et digne de confiance. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées n’est pas accessible, par exemple dans des clouds privés ou Azure Stack. Le processus de découverte instance implique la récupération des métadonnées d’autorité à partir de https://login.microsoft.com/ pour valider l’autorité.

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

loggingOptions

Permet aux utilisateurs de configurer des paramètres pour les options de stratégie de journalisation, d’autoriser la journalisation des informations de compte et des informations d’identification personnelle pour le support client.

proxyOptions

Options permettant de configurer un proxy pour les requêtes sortantes.

redirectOptions

Options de gestion des réponses de redirection.

retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.

telemetryOptions

Options permettant de définir les données de télémétrie et de suivi courantes sur les requêtes sortantes.

tlsOptions

Options de configuration de l’authentification TLS

tokenCachePersistenceOptions

Options à fournir à la couche de persistance (le cas échéant) lors du stockage des informations d’identification.

Vous devez d’abord inscrire un plug-in de fournisseur de persistance. Consultez le @azure/identity-cache-persistence package sur NPM.

Exemple :

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

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

Détails de la propriété

clientId

ID client (application) d’une inscription d’application dans le locataire.

clientId?: string

Valeur de propriété

string

loginHint

loginHint permet de pré-sélectionner un nom d’utilisateur pour les connexions interactives. La définition de cette option ignore l’invite de sélection du compte et tente immédiatement de se connecter avec le compte spécifié.

loginHint?: string

Valeur de propriété

string

redirectUri

Obtient l’URI de redirection de l’application. Cette valeur doit être identique à la valeur dans le portail d’inscription d’application. La valeur par défaut est window.location.href. Ce champ n’est plus nécessaire pour Node.js.

redirectUri?: string | () => string

Valeur de propriété

string | () => string

tenantId

ID de locataire (répertoire) Microsoft Entra.

tenantId?: string

Valeur de propriété

string

Détails de la propriété héritée

additionallyAllowedTenants

Pour les applications multilocataires, spécifie des locataires supplémentaires pour lesquels les informations d’identification peuvent acquérir des jetons. Ajoutez la valeur générique « * » pour permettre aux informations d’identification d’acquérir des jetons pour n’importe quel locataire que l’application est installée.

additionallyAllowedTenants?: string[]

Valeur de propriété

string[]

Héritéed’InteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Stratégies supplémentaires à inclure dans le pipeline HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Valeur de propriété

Héritéd’InteractiveCredentialOptions.additionalPolicies

allowInsecureConnection

Défini sur true si la requête est envoyée via HTTP au lieu de HTTPS

allowInsecureConnection?: boolean

Valeur de propriété

boolean

Héritéd’InteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Résultat d’une authentification précédente qui peut être utilisée pour récupérer les informations d’identification mises en cache de chaque compte individuel. Cela est nécessaire au cas où l’application souhaite utiliser plusieurs comptes par id client et id de locataire.

Cet enregistrement peut être récupéré en appelant la méthode des authenticate() informations d’identification, comme suit :

const authenticationRecord = await credential.authenticate();
authenticationRecord?: AuthenticationRecord

Valeur de propriété

Héritéd’InteractiveCredentialOptions.authenticationRecord

authorityHost

Hôte d’autorité à utiliser pour les demandes d’authentification. Les valeurs possibles sont disponibles via AzureAuthorityHosts. La valeur par défaut est "https://login.microsoftonline.com".

authorityHost?: string

Valeur de propriété

string

Héritéed’InteractiveCredentialOptions.authorityHost

brokerOptions

Options permettant d’autoriser l’authentification broker lors de l’utilisation d’InteractiveBrowserCredential

brokerOptions?: BrokerOptions

Valeur de propriété

Héritée deBrokerAuthOptions.brokerOptions

browserCustomizationOptions

Options de configuration partagée pour la personnalisation du navigateur

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

Valeur de propriété

{ errorMessage?: string, successMessage?: string }

Héritée deBrowserCustomizationOptions.browserCustomizationOptions

disableAutomaticAuthentication

Fait lever getToken si une authentification manuelle est nécessaire. Les développeurs devront appeler à authenticate() pour contrôler quand s’authentifier manuellement.

disableAutomaticAuthentication?: boolean

Valeur de propriété

boolean

Héritéed’InteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Le champ détermine si instance détection est effectuée lors de la tentative d’authentification. La définition de true cette valeur désactive complètement la découverte instance et la validation de l’autorité. Par conséquent, il est essentiel de s’assurer que l’hôte d’autorité configuré est valide et digne de confiance. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées n’est pas accessible, par exemple dans des clouds privés ou Azure Stack. Le processus de découverte instance implique la récupération des métadonnées d’autorité à partir de https://login.microsoft.com/ pour valider l’autorité.

disableInstanceDiscovery?: boolean

Valeur de propriété

boolean

Héritéed’InteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

httpClient?: HttpClient

Valeur de propriété

Héritéd’InteractiveCredentialOptions.httpClient

loggingOptions

Permet aux utilisateurs de configurer des paramètres pour les options de stratégie de journalisation, d’autoriser la journalisation des informations de compte et des informations d’identification personnelle pour le support client.

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

Valeur de propriété

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

Héritéed’InteractiveCredentialOptions.loggingOptions

proxyOptions

Options permettant de configurer un proxy pour les requêtes sortantes.

proxyOptions?: ProxySettings

Valeur de propriété

Héritéd’InteractiveCredentialOptions.proxyOptions

redirectOptions

Options de gestion des réponses de redirection.

redirectOptions?: RedirectPolicyOptions

Valeur de propriété

Héritéd’InteractiveCredentialOptions.redirectOptions

retryOptions

Options qui contrôlent la façon de réessayer les demandes ayant échoué.

retryOptions?: PipelineRetryOptions

Valeur de propriété

Héritéd’InteractiveCredentialOptions.retryOptions

telemetryOptions

Options permettant de définir les données de télémétrie et de suivi courantes sur les requêtes sortantes.

telemetryOptions?: TelemetryOptions

Valeur de propriété

Héritéed’InteractiveCredentialOptions.telemetryOptions

tlsOptions

Options de configuration de l’authentification TLS

tlsOptions?: TlsSettings

Valeur de propriété

Héritéd’InteractiveCredentialOptions.tlsOptions

tokenCachePersistenceOptions

Options à fournir à la couche de persistance (le cas échéant) lors du stockage des informations d’identification.

Vous devez d’abord inscrire un plug-in de fournisseur de persistance. Consultez le @azure/identity-cache-persistence package sur NPM.

Exemple :

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

Valeur de propriété

Hérité deCredentialPersistenceOptions.tokenCachePersistenceOptions

userAgentOptions

Options permettant d’ajouter des détails de l’agent utilisateur aux requêtes sortantes.

userAgentOptions?: UserAgentPolicyOptions

Valeur de propriété

Héritéed’InteractiveCredentialOptions.userAgentOptions