DeviceCodeCredential class

パッケージ:

@azure/identity

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

コンストラクター

DeviceCodeCredential(DeviceCodeCredentialOptions)

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); } });

メソッド

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

開発者は、カスタム 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)

パラメーター

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>