DeviceCodeCredential class

Microsoft Entra IDを使用してデバイス コード承認フローを開始するために必要な詳細を含む DeviceCodeCredential のインスタンスを作成します。

メッセージがログに記録され、ユーザーがアクセスした後に認証に使用できるコードがユーザーに提供されます https://microsoft.com/devicelogin

開発者は、カスタム userPromptCallbackを渡すことによって、このメッセージの表示方法を構成できます。

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  }
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

パラメーター

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

トークンをサイレントモードで取得できない場合、このメソッドはトークンを取得するためにユーザーの操作を必要とします。

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

パラメーター

戻り値

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

ユーザーが オプション disableAutomaticAuthenticationを指定した場合、トークンをサイレントモードで取得できない場合、このメソッドはトークンを取得するためのユーザー操作を要求しません。

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

パラメーター

戻り値