你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

OnBehalfOfCredential class

包:: @azure/identity

通过代表流程实现认证以Microsoft Entra ID。

构造函数

OnBehalfOfCredential(OnBehalfOfCredentialAssertionOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)

创建一个OnBehalfOfCredential实例，包含与客户端getAssertion和用户断言进行Microsoft Entra ID认证所需的详细信息。

使用 KeyClient中的示例：

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中的示例：

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中的示例：

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实例，包含与客户端getAssertion和用户断言进行Microsoft Entra ID认证所需的详细信息。

使用 KeyClient中的示例：

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中的示例：

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中的示例：

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)

使用 Microsoft Entra ID 认证，成功时返回访问令牌。如果身份验证失败，则会引发 CredentialUnavailableError，其中包含失败的详细信息。

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

参数

scopes: string | string[]

令牌有权访问的范围列表。

options: GetTokenOptions

用于配置基础网络请求的选项。

Promise<AccessToken>