OnBehalfOfCredential class

Permet l’authentification de Microsoft Entra ID en utilisant le Au nom de flow.

Constructeurs

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance du OnBehalfOfCredential avec les détails nécessaires pour s’authentifier contre Microsoft Entra ID avec un client getAssertion et une assertion utilisateur.

Exemple utilisant le KeyClient à partir de @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  getAssertion: () => {
    return Promise.resolve("my-jwt");
  },
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance du OnBehalfOfCredential avec les détails nécessaires pour s’authentifier contre Microsoft Entra ID avec un chemin vers un certificat PEM, et une assertion utilisateur.

Exemple utilisant le KeyClient à partir de @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  certificatePath: "/path/to/certificate.pem",
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance du OnBehalfOfCredential avec les détails nécessaires pour s’authentifier contre Microsoft Entra ID avec un secret client et une assertion utilisateur.

Exemple utilisant le KeyClient à partir de @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  clientSecret: "client-secret",
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");

Méthodes

getToken(string | string[], GetTokenOptions)

S’authentifie avec Microsoft Entra ID et renvoie un jeton d’accès si réussit. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.

Détails du constructeur

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance du OnBehalfOfCredential avec les détails nécessaires pour s’authentifier contre Microsoft Entra ID avec un client getAssertion et une assertion utilisateur.

Exemple utilisant le KeyClient à partir de @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  getAssertion: () => {
    return Promise.resolve("my-jwt");
  },
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Paramètres

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Paramètres facultatifs, généralement communs entre les informations d’identification.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance du OnBehalfOfCredential avec les détails nécessaires pour s’authentifier contre Microsoft Entra ID avec un chemin vers un certificat PEM, et une assertion utilisateur.

Exemple utilisant le KeyClient à partir de @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  certificatePath: "/path/to/certificate.pem",
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Paramètres

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Paramètres facultatifs, généralement communs entre les informations d’identification.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance du OnBehalfOfCredential avec les détails nécessaires pour s’authentifier contre Microsoft Entra ID avec un secret client et une assertion utilisateur.

Exemple utilisant le KeyClient à partir de @azure/keyvault-keys:

import { OnBehalfOfCredential } from "@azure/identity";
import { KeyClient } from "@azure/keyvault-keys";

const tokenCredential = new OnBehalfOfCredential({
  tenantId: "tenant-id",
  clientId: "client-id",
  clientSecret: "client-secret",
  userAssertionToken: "access-token",
});
const client = new KeyClient("vault-url", tokenCredential);

await client.getKey("key-name");
new OnBehalfOfCredential(options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Paramètres

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Paramètres facultatifs, généralement communs entre les informations d’identification.

Détails de la méthode

getToken(string | string[], GetTokenOptions)

S’authentifie avec Microsoft Entra ID et renvoie un jeton d’accès si réussit. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Paramètres

scopes

string | string[]

Liste des étendues auxquelles le jeton aura accès.

options
GetTokenOptions

Options utilisées pour configurer les requêtes réseau sous-jacentes.

Retours

Promise<AccessToken>