次の方法で共有

DeviceCodeCredential class

  • リファレンス
パッケージ:
@azure/identity

ユーザーが https://microsoft.com/deviceloginに入力できるデバイス コードを使用して、Microsoft Entra ID への認証を有効にします。

コンストラクター

DeviceCodeCredential(DeviceCodeCredentialOptions)

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

メッセージがログに記録され、https://microsoft.com/devicelogin に移動した後に認証に使用できるコードがユーザーに与 https://microsoft.com/devicelogin

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

import { DeviceCodeCredential } from "@azure/identity";

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

メソッド

authenticate(string | string[], GetTokenOptions)

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

トークンをサイレントで取得できない場合、このメソッドは常にユーザーにチャレンジを生成します。
getToken(string | string[], GetTokenOptions)

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

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

コンストラクターの詳細

DeviceCodeCredential(DeviceCodeCredentialOptions)

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

メッセージがログに記録され、https://microsoft.com/devicelogin に移動した後に認証に使用できるコードがユーザーに与 https://microsoft.com/devicelogin

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

import { DeviceCodeCredential } from "@azure/identity";

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

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

パラメーター

options
DeviceCodeCredentialOptions

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

メソッドの詳細

authenticate(string | string[], GetTokenOptions)

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

トークンをサイレントで取得できない場合、このメソッドは常にユーザーにチャレンジを生成します。

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

パラメーター

scopes

string | string[]

トークンがアクセスできるスコープの一覧。

options
GetTokenOptions

この TokenCredential 実装が行う可能性がある要求を構成するために使用されるオプション。

戻り値

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

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

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

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

パラメーター

scopes

string | string[]

トークンがアクセスできるスコープの一覧。

options
GetTokenOptions

この TokenCredential 実装が行う可能性がある要求を構成するために使用されるオプション。

戻り値

Promise<AccessToken>