Bagikan melalui

OnBehalfOfCredential class

Paket:
@azure/identity

Mengaktifkan autentikasi ke ID Microsoft Entra menggunakan Atas Nama alur.

Konstruktor

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Membuat instans onBehalfOfCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan getAssertion klien dan pernyataan pengguna.

Contoh menggunakan KeyClient dari @azure/keyvault-key:

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)

Membuat instans OnBehalfOfCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan jalur ke sertifikat PEM, dan pernyataan pengguna.

Contoh menggunakan KeyClient dari @azure/keyvault-key:

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)

Membuat instans OnBehalfOfCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan rahasia klien dan pernyataan pengguna.

Contoh menggunakan KeyClient dari @azure/keyvault-key:

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");

Metode

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan ID Microsoft Entra dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

Detail Konstruktor

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Membuat instans onBehalfOfCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan getAssertion klien dan pernyataan pengguna.

Contoh menggunakan KeyClient dari @azure/keyvault-key:

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)

Parameter

options

OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parameter opsional, umumnya umumnya di seluruh kredensial.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Membuat instans OnBehalfOfCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan jalur ke sertifikat PEM, dan pernyataan pengguna.

Contoh menggunakan KeyClient dari @azure/keyvault-key:

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)

Parameter

options

OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parameter opsional, umumnya umumnya di seluruh kredensial.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

Membuat instans OnBehalfOfCredential dengan detail yang diperlukan untuk mengautentikasi terhadap ID Microsoft Entra dengan rahasia klien dan pernyataan pengguna.

Contoh menggunakan KeyClient dari @azure/keyvault-key:

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)

Parameter

options

OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

Parameter opsional, umumnya umumnya di seluruh kredensial.

Detail Metode

getToken(string | string[], GetTokenOptions)

Mengautentikasi dengan ID Microsoft Entra dan mengembalikan token akses jika berhasil. Jika autentikasi gagal, CredentialUnavailableError akan dilemparkan dengan detail kegagalan.

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

Parameter

scopes

string | string[]

Daftar cakupan yang tokennya akan memiliki akses.

options
GetTokenOptions

Opsi yang digunakan untuk mengonfigurasi permintaan jaringan yang mendasar.

Mengembalikan

Promise<AccessToken>