ClientCertificateCredential class
啟用驗證以使用指派給應用程式註冊的 PEM 編碼憑證來 Microsoft Entra ID。 如需如何設定憑證驗證的詳細資訊,請參閱這裡:
建構函式
Client |
使用憑證針對 Microsoft Entra ID 進行驗證所需的詳細數據,建立 ClientCertificateCredential 的實例。 |
Client |
使用憑證針對 Microsoft Entra ID 進行驗證所需的詳細數據,建立 ClientCertificateCredential 的實例。 |
Client |
使用憑證針對 Microsoft Entra ID 進行驗證所需的詳細數據,建立 ClientCertificateCredential 的實例。 |
方法
get |
使用 Microsoft Entra ID 進行驗證,並在成功時傳回存取令牌。 如果驗證失敗,則會擲回 CredentialUnavailableError ,並包含失敗的詳細數據。 |
建構函式詳細資料
ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)
使用憑證針對 Microsoft Entra ID 進行驗證所需的詳細數據,建立 ClientCertificateCredential 的實例。
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificate, options?: ClientCertificateCredentialOptions)
參數
- tenantId
-
string
Microsoft Entra 租使用者 (目錄) 識別符。
- clientId
-
string
用戶端 (應用程式) 租用戶中應用程式註冊的標識碼。
- configuration
- ClientCertificatePEMCertificate
其他必要參數,包括 PEM 編碼憑證作為字串。 如果忽略類型,我們會擲回 PEM 編碼憑證的值。
設定發出驗證要求的客戶端的選項。
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)
使用憑證針對 Microsoft Entra ID 進行驗證所需的詳細數據,建立 ClientCertificateCredential 的實例。
new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)
參數
- tenantId
-
string
Microsoft Entra 租使用者 (目錄) 識別符。
- clientId
-
string
用戶端 (應用程式) 租用戶中應用程式註冊的標識碼。
- configuration
- ClientCertificatePEMCertificatePath
需要其他參數,包括文件系統上憑證的路徑。 如果忽略類型,我們會擲回 PEM 憑證路徑的值。
設定發出驗證要求的客戶端的選項。
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)
使用憑證針對 Microsoft Entra ID 進行驗證所需的詳細數據,建立 ClientCertificateCredential 的實例。
new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)
參數
- tenantId
-
string
Microsoft Entra 租使用者 (目錄) 識別符。
- clientId
-
string
用戶端 (應用程式) 租用戶中應用程式註冊的標識碼。
- certificatePath
-
string
檔系統上 PEM 編碼的公開/私鑰憑證路徑。
設定發出驗證要求的客戶端的選項。
方法詳細資料
getToken(string | string[], GetTokenOptions)
使用 Microsoft Entra ID 進行驗證,並在成功時傳回存取令牌。 如果驗證失敗,則會擲回 CredentialUnavailableError ,並包含失敗的詳細數據。
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
參數
- scopes
-
string | string[]
令牌可存取的範圍清單。
- options
- GetTokenOptions
用來設定此 TokenCredential 實作之任何要求的選項。
傳回
Promise<AccessToken>