CommonDeviceCodeRequest type

Пакет:
@azure/msal-common

Параметры потока кода устройства Oauth2.

  • области — массив областей, к к которые приложение запрашивает доступ.
  • центр: — URL-адрес центра, служба маркеров безопасности (STS), из которой MSAL получит маркеры. Если центр задан в объекте клиентского приложения, это переопределит это значение. Переопределение значения приведет к тому, что проверка центра будет выполняться каждый раз. Если один и тот же центр будет использоваться для всех запросов, задайте для объекта приложения вместо запросов.
  • correlationId — уникальный набор GUID для каждого запроса для трассировки сквозного запроса для целей телеметрии.
  • deviceCodeCallback — обратный вызов, содержащий ответ кода устройства. Сообщение должно отображаться для конечного пользователя. Затем конечный пользователь может перейти к verification_uri, ввести user_code и входные учетные данные.
  • отмена — логическое значение для отмены опроса конечной точки кода устройства. Хотя пользователь проходит проверку подлинности на отдельном устройстве, MSAL опрашивает конечную точку маркера службы маркеров безопасности за интервал, указанный в ответе кода устройства (обычно 15 минут). Чтобы остановить опрос и отменить запрос, задайте значение cancel=true.
  • resourceRequestMethod — тип HTTP-запроса, используемый для запроса данных из ресурса (например, GET, POST и т. д.). Используется для потоков подтверждения владения.
  • resourceRequestUri — URI, для этого маркера будет использоваться. Используется для потоков подтверждения владения.
  • время ожидания — период ожидания в секундах, в течение которых пользователь явно настраивает для опроса конечной точки кода устройства. В конце этого периода; Если код устройства еще не истек; Опрос кода устройства останавливается и запрос отменен. Окно истечения срока действия кода устройства всегда будет иметь приоритет над этим заданным периодом.
  • extraQueryParameters — строка на строку сопоставления настраиваемых параметров запроса, добавленных в строку запроса.
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}