OnBehalfOfCredential class
啟用驗證以使用代理流程 Microsoft Entra ID。
建構函式
On |
使用 PEM 憑證的路徑和使用者判斷提示,建立 OnBehalfOfCredential 的實例,其中包含針對 Microsoft Entra ID 進行驗證所需的詳細數據。 使用
|
On |
使用用戶端密碼和使用者判斷提示,建立 OnBehalfOfCredential 的實例,其中包含針對 Microsoft Entra ID 進行驗證所需的詳細數據。 使用
|
方法
get |
使用 Microsoft Entra ID 進行驗證,並在成功時傳回存取令牌。 如果驗證失敗,將會擲回 CredentialUnavailableError 並顯示失敗的詳細數據。 |
建構函式詳細資料
OnBehalfOfCredential(OnBehalfOfCredentialCertificateOptions & MultiTenantTokenCredentialOptions & CredentialPersistenceOptions)
使用 PEM 憑證的路徑和使用者判斷提示,建立 OnBehalfOfCredential 的實例,其中包含針對 Microsoft Entra ID 進行驗證所需的詳細數據。
使用 KeyClient
來自 @azure/keyvault-keys 的範例:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
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 的範例:
const tokenCredential = new OnBehalfOfCredential({
tenantId,
clientId,
clientSecret,
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>