DeviceCodeCredential class
Включает проверку подлинности для Microsoft Entra ID с помощью кода устройства, который пользователь может ввести в https://microsoft.com/devicelogin.
Конструкторы
Device |
Создает экземпляр DeviceCodeCredential со сведениями, необходимыми для запуска потока авторизации кода устройства с помощью Microsoft Entra ID. Сообщение будет зарегистрировано, предоставляя пользователям код, который они могут использовать для проверки подлинности после перехода на страницу https://microsoft.com/devicelogin Разработчики могут настроить способ отображения этого сообщения, передав пользовательский
|
Методы
authenticate(string | string[], Get |
Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError с подробными сведениями об ошибке. Если маркер не может быть получен автоматически, для получения маркера потребуется взаимодействие пользователя. |
get |
Выполняет проверку подлинности с помощью Microsoft Entra ID и возвращает маркер доступа в случае успешного выполнения. Если проверка подлинности завершается сбоем, выдается credentialUnavailableError с подробными сведениями об ошибке. Если пользователь предоставил параметр |
Сведения о конструкторе
DeviceCodeCredential(DeviceCodeCredentialOptions)
Создает экземпляр DeviceCodeCredential со сведениями, необходимыми для запуска потока авторизации кода устройства с помощью Microsoft Entra ID.
Сообщение будет зарегистрировано, предоставляя пользователям код, который они могут использовать для проверки подлинности после перехода на страницу 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>