ClientAssertionCredential class

JWT アサーションを使用してサービス プリンシパルを認証します。

コンストラクター

ClientAssertionCredential(string, string, () => Promise<string>, ClientAssertionCredentialOptions)

ClientAssertionCredentialのインスタンスを作成し、開発者がMicrosoft Entra IDgetAssertion関数パラメータを通じて提供したクライアントアサーションで認証に必要な詳細を含みます。

メソッド

getToken(string | string[], GetTokenOptions)

Microsoft Entra IDで認証し、成功するとアクセストークンを返します。 認証に失敗すると、CredentialUnavailableError がスローされ、エラーの詳細が表示されます。

コンストラクターの詳細

ClientAssertionCredential(string, string, () => Promise<string>, ClientAssertionCredentialOptions)

ClientAssertionCredentialのインスタンスを作成し、開発者がMicrosoft Entra IDgetAssertion関数パラメータを通じて提供したクライアントアサーションで認証に必要な詳細を含みます。

new ClientAssertionCredential(tenantId: string, clientId: string, getAssertion: () => Promise<string>, options?: ClientAssertionCredentialOptions)

パラメーター

tenantId

string

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

clientId

string

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

getAssertion

() => Promise<string>

使用する資格情報のアサーションを取得する関数。

options
ClientAssertionCredentialOptions

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

メソッドの詳細

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>