Partager via

OnBehalfOfCredential class

  • Référence
Paquet:
@azure/identity

Active l’authentification auprès de Microsoft Entra ID à l’aide de la au nom du flux.

Constructeurs

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crée une instance de l'OnBehalfOfCredential avec les détails nécessaires à l’authentification auprès de l’ID Microsoft Entra avec un client getAssertion et une assertion utilisateur.

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

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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 à l’authentification auprès de l’ID Microsoft Entra avec le chemin d’accès à un certificat PEM et une assertion utilisateur.

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

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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 à l’authentification auprès de Microsoft Entra ID avec une clé secrète client et une assertion utilisateur.

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

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

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

Méthodes

getToken(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite. 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 de l'OnBehalfOfCredential avec les détails nécessaires à l’authentification auprès de l’ID Microsoft Entra avec un client getAssertion et une assertion utilisateur.

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

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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 à l’authentification auprès de l’ID Microsoft Entra avec le chemin d’accès à un certificat PEM et une assertion utilisateur.

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

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  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 à l’authentification auprès de Microsoft Entra ID avec une clé secrète client et une assertion utilisateur.

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

const tokenCredential = new OnBehalfOfCredential({
  tenantId,
  clientId,
  clientSecret,
  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 l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite. 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>