DeviceCodeCredential class

Пакет:
@azure/identity

Позволяет аутентификация Microsoft Entra ID с помощью кода устройства, который пользователь может ввести в https://microsoft.com/devicelogin.

Конструкторы

DeviceCodeCredential(DeviceCodeCredentialOptions)

Создаёт экземпляр DeviceCodeCredential с необходимыми деталями для запуска процесса авторизации кода устройства с помощью Microsoft Entra ID.

Сообщение будет зарегистрировано, предоставляя пользователям код, который они могут использовать для проверки подлинности после перехода к 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)

Создаёт экземпляр DeviceCodeCredential с необходимыми деталями для запуска процесса авторизации кода устройства с помощью Microsoft Entra ID.

Сообщение будет зарегистрировано, предоставляя пользователям код, который они могут использовать для проверки подлинности после перехода к 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>