ClientCertificateCredential class

パッケージ:

@azure/identity

アプリ登録に割り当てられている PEM でエンコードされた証明書を使用して認証をMicrosoft Entra IDできるようにします。 証明書認証を構成する方法の詳細については、こちらを参照してください。

https://learn.microsoft.com/en-us/azure/active-directory/develop/active-directory-certificate-credentials#register-your-certificate-with-azure-ad

コンストラクター

ClientCertificateCredential(string, string, ClientCertificatePEMCertificate, ClientCertificateCredentialOptions)	証明書を使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientCertificateCredential のインスタンスを作成します。
ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)	証明書を使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientCertificateCredential のインスタンスを作成します。
ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)	証明書を使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientCertificateCredential のインスタンスを作成します。

メソッド

getToken(string | string[], GetTokenOptions)

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 テナント (ディレクトリ) ID。

clientId

string

テナント内のアプリの登録のクライアント (アプリケーション) ID。

configuration

ClientCertificatePEMCertificate

PEM でエンコードされた証明書を文字列として含む、その他のパラメーターが必要です。 型が無視された場合は、PEM でエンコードされた証明書の値がスローされます。

options

ClientCertificateCredentialOptions

認証要求を行うクライアントを構成するためのオプション。

ClientCertificateCredential(string, string, ClientCertificatePEMCertificatePath, ClientCertificateCredentialOptions)

証明書を使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientCertificateCredential のインスタンスを作成します。

new ClientCertificateCredential(tenantId: string, clientId: string, configuration: ClientCertificatePEMCertificatePath, options?: ClientCertificateCredentialOptions)

パラメーター

tenantId

string

Microsoft Entra テナント (ディレクトリ) ID。

clientId

string

テナント内のアプリの登録のクライアント (アプリケーション) ID。

configuration

ClientCertificatePEMCertificatePath

ファイルシステム上の証明書のパスなど、必要なその他のパラメーター。 型が無視された場合は、PEM 証明書へのパスの値がスローされます。

options

ClientCertificateCredentialOptions

認証要求を行うクライアントを構成するためのオプション。

ClientCertificateCredential(string, string, string, ClientCertificateCredentialOptions)

証明書を使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientCertificateCredential のインスタンスを作成します。

new ClientCertificateCredential(tenantId: string, clientId: string, certificatePath: string, options?: ClientCertificateCredentialOptions)

パラメーター

tenantId

string

Microsoft Entra テナント (ディレクトリ) ID。

clientId

string

テナント内のアプリの登録のクライアント (アプリケーション) ID。

certificatePath

string

ファイルシステム上の PEM でエンコードされた公開/秘密キー証明書へのパス。

options

ClientCertificateCredentialOptions

認証要求を行うクライアントを構成するためのオプション。

メソッドの詳細

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>