OnBehalfOfCredential class

Csomag:

@azure/identity

Lehetővé teszi a hitelesítést Microsoft Entra ID On Of Of Flow használatával.

Konstruktorok

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)	Létrehoz egy példányt a OnBehalfOfCredential adataival, amelyekkel a Microsoft Entra ID ellen hitelesítéshez szükséges egy kliensszel getAssertion és egy felhasználói állítással. Példa a KeyClient használatával: 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)	Létrehoz egy példányt a OnBehalfOfCredential fájlból, amelyekkel a PEM tanúsítványhoz vezető úttal és felhasználói állítással Microsoft Entra ID ellen hitelesítéshez szükséges adatokkal. Példa a KeyClient használatával: 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)	Létrehoz egy példányt a OnBehalfOfCredential fájlból, amelyekkel a Microsoft Entra ID ellen való hitelesítéshez szükséges adatokat szolgáltatja egy klienstitkos és felhasználói állítás. Példa a KeyClient használatával: 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");

Metódusok

getToken(string | string[], GetTokenOptions)

Hitelesít Microsoft Entra ID-vel, és ha sikeres, hozzáférési tokent ad vissza. Ha a hitelesítés sikertelen, egy CredentialUnavailableError jelenik meg a hiba részleteivel.

Konstruktor adatai

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Létrehoz egy példányt a OnBehalfOfCredential adataival, amelyekkel a Microsoft Entra ID ellen hitelesítéshez szükséges egy kliensszel getAssertion és egy felhasználói állítással.

Példa a KeyClient használatával:

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éterek

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Nem kötelező paraméterek, általában a hitelesítő adatok között gyakoriak.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Létrehoz egy példányt a OnBehalfOfCredential fájlból, amelyekkel a PEM tanúsítványhoz vezető úttal és felhasználói állítással Microsoft Entra ID ellen hitelesítéshez szükséges adatokkal.

Példa a KeyClient használatával:

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éterek

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Nem kötelező paraméterek, általában a hitelesítő adatok között gyakoriak.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Létrehoz egy példányt a OnBehalfOfCredential fájlból, amelyekkel a Microsoft Entra ID ellen való hitelesítéshez szükséges adatokat szolgáltatja egy klienstitkos és felhasználói állítás.

Példa a KeyClient használatával:

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éterek

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Nem kötelező paraméterek, általában a hitelesítő adatok között gyakoriak.

Metódus adatai

getToken(string | string[], GetTokenOptions)

Hitelesít Microsoft Entra ID-vel, és ha sikeres, hozzáférési tokent ad vissza. Ha a hitelesítés sikertelen, egy CredentialUnavailableError jelenik meg a hiba részleteivel.

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

Paraméterek

scopes

string | string[]

Azon hatókörök listája, amelyekhez a jogkivonatnak hozzáférése lesz.

options

GetTokenOptions

A mögöttes hálózati kérések konfigurálásához használt beállítások.

Válaszok

Promise<AccessToken>