OnBehalfOfCredential class

Pakiet:

@azure/identity

Umożliwia uwierzytelnianie Microsoft Entra ID za pomocą On Behalf Of flow.

Konstruktory

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)	Tworzy instancję OnBehalfOfCredential z detalami potrzebnymi do uwierzytelnienia wobec Microsoft Entra ID klienta getAssertion oraz asercją użytkownika. Przykład użycia KeyClient z @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)	Tworzy instancję OnBehalfOfCredential z detalami potrzebnymi do uwierzytelnienia względem Microsoft Entra ID z drogą do certyfikatu PEM oraz asercją użytkownika. Przykład użycia KeyClient z @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)	Tworzy instancję OnBehalfOfCredential z detalami potrzebnymi do uwierzytelnienia Microsoft Entra ID za pomocą sekretu klienta i asercji użytkownika. Przykład użycia KeyClient z @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");

Metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

Szczegóły konstruktora

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy instancję OnBehalfOfCredential z detalami potrzebnymi do uwierzytelnienia wobec Microsoft Entra ID klienta getAssertion oraz asercją użytkownika.

Przykład użycia KeyClient z @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)

Parametry

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametry opcjonalne, zwykle wspólne dla poświadczeń.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy instancję OnBehalfOfCredential z detalami potrzebnymi do uwierzytelnienia względem Microsoft Entra ID z drogą do certyfikatu PEM oraz asercją użytkownika.

Przykład użycia KeyClient z @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)

Parametry

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametry opcjonalne, zwykle wspólne dla poświadczeń.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Tworzy instancję OnBehalfOfCredential z detalami potrzebnymi do uwierzytelnienia Microsoft Entra ID za pomocą sekretu klienta i asercji użytkownika.

Przykład użycia KeyClient z @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)

Parametry

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parametry opcjonalne, zwykle wspólne dla poświadczeń.

Szczegóły metody

getToken(string | string[], GetTokenOptions)

Uwierzytelnia się za pomocą Microsoft Entra ID i zwraca token dostępu w przypadku powodzenia. Jeśli uwierzytelnianie nie powiedzie się, zostanie zgłoszony CredentialUnavailableError ze szczegółami błędu.

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

Parametry

scopes

string | string[]

Lista zakresów, dla których token będzie miał dostęp.

options

GetTokenOptions

Opcje używane do konfigurowania podstawowych żądań sieciowych.

Zwraca

Promise<AccessToken>