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>