Share via


ClientSecretCredential class

アプリ登録用に生成されたクライアント シークレットを使用して認証をMicrosoft Entra IDできるようにします。 クライアント シークレットを構成する方法の詳細については、こちらを参照してください。

https://learn.microsoft.com/entra/identity-platform/quickstart-configure-app-access-web-apis#add-credentials-to-your-web-application

コンストラクター

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

クライアント シークレットを使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientSecretCredential のインスタンスを作成します。

メソッド

getToken(string | string[], GetTokenOptions)

Microsoft Entra IDで認証し、成功した場合はアクセス トークンを返します。 認証が失敗した場合、失敗の詳細を含む CredentialUnavailableError がスローされます。

コンストラクターの詳細

ClientSecretCredential(string, string, string, ClientSecretCredentialOptions)

クライアント シークレットを使用してMicrosoft Entra IDに対する認証に必要な詳細を含む ClientSecretCredential のインスタンスを作成します。

new ClientSecretCredential(tenantId: string, clientId: string, clientSecret: string, options?: ClientSecretCredentialOptions)

パラメーター

tenantId

string

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

clientId

string

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

clientSecret

string

アプリの登録で生成されたクライアント シークレット。

options
ClientSecretCredentialOptions

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

メソッドの詳細

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>