OnBehalfOfCredential class

الحزمة:: @azure/identity

يتيح المصادقة Microsoft Entra ID باستخدام نيابة عن الflow.

المنشئون

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

ينشئ نسخة من OnBehalfOfCredential مع التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID مع العميل getAssertion وتأكيد المستخدم.

مثال باستخدام KeyClient من @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)

ينشئ نسخة من OnBehalfOfCredential مع التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID مع مسار إلى شهادة PEM وتأكيد المستخدم.

مثال باستخدام KeyClient من @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)

ينشئ نسخة من OnBehalfOfCredential مع التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID مع سر العميل وتأكيد المستخدم.

مثال باستخدام KeyClient من @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");

الأساليب

getToken(string | string[], GetTokenOptions)

يتم التحقق من المصادقة باستخدام معرف Microsoft Entra ID ويعيد رمز الوصول إذا نجحت. إذا فشلت المصادقة، طرح CredentialUnavailableError مع تفاصيل الفشل.

تفاصيل المنشئ

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

ينشئ نسخة من OnBehalfOfCredential مع التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID مع العميل getAssertion وتأكيد المستخدم.

مثال باستخدام KeyClient من @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)

المعلمات

options: OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

المعلمات الاختيارية، الشائعة بشكل عام عبر بيانات الاعتماد.

OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

ينشئ نسخة من OnBehalfOfCredential مع التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID مع مسار إلى شهادة PEM وتأكيد المستخدم.

مثال باستخدام KeyClient من @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)

المعلمات

options: OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

المعلمات الاختيارية، الشائعة بشكل عام عبر بيانات الاعتماد.

OnBehalfOfCredential(OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

ينشئ نسخة من OnBehalfOfCredential مع التفاصيل اللازمة للمصادقة ضد Microsoft Entra ID مع سر العميل وتأكيد المستخدم.

مثال باستخدام KeyClient من @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)

المعلمات

options: OnBehalfOfCredentialSecretOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions

المعلمات الاختيارية، الشائعة بشكل عام عبر بيانات الاعتماد.

تفاصيل الأسلوب

getToken(string | string[], GetTokenOptions)

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

المعلمات

scopes: string | string[]

قائمة النطاقات التي سيكون للرمز المميز حق الوصول إليها.

options: GetTokenOptions

الخيارات المستخدمة لتكوين طلبات الشبكة الأساسية.

المرتجعات

Promise<AccessToken>