DeviceCodeFlowParameters Класс

Пакет:
com.microsoft.aad.msal4j
Артефакт Maven:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.DeviceCodeFlowParameters

Реализации

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class DeviceCodeFlowParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Объект, содержащий параметры для потока кода устройства. Можно использовать в качестве параметра acquireToken(DeviceCodeFlowParameters parameters). Дополнительные сведения см. на странице https://aka.ms/msal4j-device-code

Сводка по методу

Модификатор и тип Метод и описание
static DeviceCodeFlowParametersBuilder builder(Set<String> scopes, Consumer<DeviceCode> deviceCodeConsumer)

Построитель для DeviceCodeFlowParameters
ClaimsRequest claims()

Возвращает параметр запроса утверждений, который будет отправлен с помощью запроса проверки подлинности.
java.util.function.Consumer<DeviceCode> deviceCodeConsumer()
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Возвращает дополнительные заголовки HTTP, которые будут включены в запрос токена.
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Не рекомендуется

Не рекомендуется для рабочих сценариев. Он будет удален в будущем выпуске, и поведение может быть заменено новым API.

Возвращает дополнительные параметры запроса, которые будут включены в запрос маркера.
java.util.Set<java.lang.String> scopes()

Возвращает набор областей (разрешений), запрошенных для маркера доступа.
java.lang.String tenant()

Возвращает идентификатор клиента для запроса маркера.

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Сведения о методе

builder

public static DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder builder(Set<String> scopes, Consumer<DeviceCode> deviceCodeConsumer)

Построитель для DeviceCodeFlowParameters

Параметры:

scopes - Приложение scopes запрашивает доступ к
deviceCodeConsumer - Consumer из DeviceCode

Возвращаемое значение:

построитель, который можно использовать для создания устройств DeviceCodeFlowParameters

claims

public ClaimsRequest claims()

Возвращает параметр запроса утверждений, который будет отправлен с помощью запроса проверки подлинности.

Параметр запроса утверждений можно использовать для запроса конкретных утверждений, возвращаемых в маркере, для запроса проверки подлинности MFA или управления другими аспектами выдачи маркеров.

deviceCodeConsumer

public Consumer<DeviceCode> deviceCodeConsumer()

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Возвращает дополнительные заголовки HTTP, которые будут включены в запрос токена.

Эти заголовки будут добавлены в HTTP-запросы, отправленные в конечную точку маркера. Это может быть полезно для сценариев, требующих пользовательских заголовков для прокси-серверов или для диагностических целей.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Не рекомендуется

Не рекомендуется для рабочих сценариев. Он будет удален в будущем выпуске, и поведение может быть заменено новым API.

Возвращает дополнительные параметры запроса, которые будут включены в запрос маркера.

Эти параметры будут добавлены в строку запроса в запросах к конечным точкам авторизации и маркера. Это может быть полезно для сценариев, требующих пользовательских параметров, которые явно не поддерживаются в библиотеке.

scopes

public Set<String> scopes()

Возвращает набор областей (разрешений), запрошенных для маркера доступа.

Области представляют разрешения, к которым приложение запрашивает доступ.

tenant

public String tenant()

Возвращает идентификатор клиента для запроса маркера.

При указании это значение переопределяет клиент, указанный в URL-адресе центра приложения. Это может быть идентификатор клиента (GUID), доменное имя или одно из специальных значений, таких как common или "организации".

Применяется к