InteractiveRequestParameters Класс
- java.
lang. Object - com.
microsoft. aad. msal4j. InteractiveRequestParameters
- com.
Реализации
public class InteractiveRequestParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters
Объект, содержащий параметры для интерактивных запросов. Можно использовать в качестве параметра acquireToken(InteractiveRequestParameters parameters).
Дополнительные сведения см. в статье https://aka.ms/msal4j-interactive-request.
Сводка по методу
| Модификатор и тип | Метод и описание |
|---|---|
|
static
Interactive |
builder(URI redirectUri) |
|
Claims |
claims()
Утверждения, запрашиваемые с помощью параметра запроса утверждений OIDC, разрешающие запросы на стандартные и пользовательские утверждения |
| java.lang.String | claimsChallenge() |
| java.lang.String |
domainHint()
Предоставляет указание о клиенте или домене, который пользователь должен использовать для входа. |
| java.util.Map<java.lang.String,java.lang.String> |
extraHttpHeaders()
Добавляет дополнительные заголовки в запрос маркера |
| java.util.Map<java.lang.String,java.lang.String> |
extraQueryParameters()
Добавляет дополнительные параметры запроса в запрос маркера |
| int |
httpPollingTimeoutInSeconds()
Время в секундах, которое библиотека ожидает результата проверки подлинности. |
| boolean |
instanceAware()
Если задано значение true, результат авторизации будет содержать центр для домашнего облака пользователя, и этот центр будет использоваться для запроса токена вместо центра, заданного в приложении. |
| java.lang.String |
loginHint()
Можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа для пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. |
| Prompt |
prompt()
Укажите тип необходимого взаимодействия с пользователем. |
|
Pop |
proofOfPossession() |
| @lombok.NonNull java.net.URI |
redirectUri()
URI перенаправления, в котором MSAL будет прослушивать код авторизации, возвращенный Azure AD. |
| java.util.Set<java.lang.String> |
scopes()
Области, к которым приложение запрашивает доступ, и пользователь даст согласие. |
|
System |
systemBrowserOptions()
Наборы SystemBrowserOptions , используемые общедоступным |
| java.lang.String |
tenant()
Переопределяет значение клиента в URL-адресе центра для этого запроса. |
| long |
windowHandle()
Родительский дескриптор окна, используемый для открытия элементов пользовательского интерфейса с правильным родительским объектом для сценариев браузера и Windows консольных приложений, этот параметр не должен быть Windows задан для консольных приложений, MSAL Java попытается обнаружить дескриптор окна консоли, если этот параметр не задан для сценариев, в которых MSAL Java отвечает за открытие элементов пользовательского интерфейса (например, при использовании MSALRuntime), этот параметр требуется, и исключение будет создано, если не задано. |
Методы, унаследованные от java.lang.Object
Сведения о методе
builder
public static InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)
Параметры:
claims
public ClaimsRequest claims()
Утверждения, запрашиваемые с помощью параметра запроса утверждений OIDC, разрешающие запросы на стандартные и пользовательские утверждения
claimsChallenge
public String claimsChallenge()
domainHint
public String domainHint()
Предоставляет указание о клиенте или домене, который пользователь должен использовать для входа. Значение указания домена — это зарегистрированный домен для клиента.
extraHttpHeaders
public Map<String,String> extraHttpHeaders()
Добавляет дополнительные заголовки в запрос маркера
extraQueryParameters
public Map<String,String> extraQueryParameters()
Добавляет дополнительные параметры запроса в запрос маркера
httpPollingTimeoutInSeconds
public int httpPollingTimeoutInSeconds()
Время в секундах, которое библиотека ожидает результата проверки подлинности. 120 секунд — это время ожидания по умолчанию, если не переопределено здесь с другим положительным целым числом, если это время ожидания равно 0 или меньше, оно будет игнорироваться, и библиотека будет использовать вместо этого 1 секундное время ожидания.
instanceAware
public boolean instanceAware()
Если задано значение true, результат авторизации будет содержать центр для домашнего облака пользователя, и этот центр будет использоваться для запроса токена вместо центра, заданного в приложении.
loginHint
public String loginHint()
Можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа для пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. Часто приложения используют этот параметр во время повторной проверки подлинности, уже извлекая имя пользователя из предыдущего входа с помощью утверждения preferred_username.
prompt
public Prompt prompt()
Укажите тип необходимого взаимодействия с пользователем.
proofOfPossession
public PopParameters proofOfPossession()
redirectUri
public @NonNull URI redirectUri()
URI перенаправления, в котором MSAL будет прослушивать код авторизации, возвращенный Azure AD. Должен быть адрес обратного цикла с указанным портом (например, http://localhost:3671). Если порт не указан, MSAL найдет открытый порт. Дополнительные сведения см. в разделе https://aka.ms/msal4j-interactive-request.
scopes
public Set<String> scopes()
Области, к которым приложение запрашивает доступ, и пользователь даст согласие.
systemBrowserOptions
public SystemBrowserOptions systemBrowserOptions()
Наборы SystemBrowserOptions , используемые PublicClientApplication
tenant
public String tenant()
Переопределяет значение клиента в URL-адресе центра для этого запроса.
windowHandle
public long windowHandle()
Родительский дескриптор окна, используемый для открытия элементов пользовательского интерфейса с правильным родительским объектом для сценариев браузера и Windows консольных приложений, этот параметр не должен быть Windows задан для консольных приложений, MSAL Java попытается обнаружить дескриптор окна консоли, если этот параметр не задан для сценариев, в которых MSAL Java отвечает за открытие элементов пользовательского интерфейса (например, при использовании MSALRuntime), этот параметр требуется, и исключение будет создано, если не задано.