Condividi tramite

OnBehalfOfCredential class

  • Riferimento
Pacchetto:
@azure/identity

Consente l'autenticazione a Microsoft Entra ID usando il flusso on behalf of.

Costruttori

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea un'istanza del OnBehalfOfCredential con i dettagli necessari per eseguire l'autenticazione con l'ID Microsoft Entra con un client getAssertion e un'asserzione utente.

Esempio di uso del KeyClient da @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)

Crea un'istanza del OnBehalfOfCredential con i dettagli necessari per eseguire l'autenticazione con l'ID di Microsoft Entra con il percorso di un certificato PEM e un'asserzione utente.

Esempio di uso del KeyClient da @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)

Crea un'istanza del OnBehalfOfCredential con i dettagli necessari per eseguire l'autenticazione in Microsoft Entra ID con un segreto client e un'asserzione utente.

Esempio di uso del KeyClient da @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");

Metodi

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo. Se l'autenticazione non riesce, verrà generata una CredentialUnavailableError con i dettagli dell'errore.

Dettagli costruttore

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea un'istanza del OnBehalfOfCredential con i dettagli necessari per eseguire l'autenticazione con l'ID Microsoft Entra con un client getAssertion e un'asserzione utente.

Esempio di uso del KeyClient da @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)

Parametri

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametri facoltativi, in genere comuni tra le credenziali.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea un'istanza del OnBehalfOfCredential con i dettagli necessari per eseguire l'autenticazione con l'ID di Microsoft Entra con il percorso di un certificato PEM e un'asserzione utente.

Esempio di uso del KeyClient da @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)

Parametri

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametri facoltativi, in genere comuni tra le credenziali.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Crea un'istanza del OnBehalfOfCredential con i dettagli necessari per eseguire l'autenticazione in Microsoft Entra ID con un segreto client e un'asserzione utente.

Esempio di uso del KeyClient da @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)

Parametri

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametri facoltativi, in genere comuni tra le credenziali.

Dettagli metodo

getToken(string | string[], GetTokenOptions)

Esegue l'autenticazione con Microsoft Entra ID e restituisce un token di accesso in caso di esito positivo. Se l'autenticazione non riesce, verrà generata una CredentialUnavailableError con i dettagli dell'errore.

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

Parametri

scopes

string | string[]

Elenco di ambiti per i quali il token avrà accesso.

options
GetTokenOptions

Opzioni utilizzate per configurare le richieste di rete sottostanti.

Restituisce

Promise<AccessToken>