InteractiveRequestParameters.InteractiveRequestParametersBuilder Класс

Пакет:

com.microsoft.aad.msal4j

Артефакт Maven:

com.microsoft.azure:msal4j:1.26.0

• java.lang.Object
• • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

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

Модификатор и тип	Метод и описание
InteractiveRequestParameters	build()
InteractiveRequestParametersBuilder	claims(ClaimsRequest claims) Утверждения, запрашиваемые с помощью параметра запроса утверждений OIDC, разрешающие запросы на стандартные и пользовательские утверждения
InteractiveRequestParametersBuilder	claimsChallenge(String claimsChallenge) Используется при сбое запроса маркера и ответ имеет строку вызова
InteractiveRequestParametersBuilder	domainHint(String domainHint) Предоставляет указание о клиенте или домене, который пользователь должен использовать для входа.
InteractiveRequestParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Добавляет дополнительные заголовки в запрос маркера
InteractiveRequestParametersBuilder	extraQueryParameters(Map<String,String> extraQueryParameters) Не рекомендуется Не рекомендуется для рабочих сценариев. Он будет удален в будущем выпуске, и поведение может быть заменено новым API. Добавляет дополнительные параметры запроса в запрос маркера
InteractiveRequestParametersBuilder	httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds) Время в секундах, которое библиотека ожидает результата проверки подлинности.
InteractiveRequestParametersBuilder	instanceAware(boolean instanceAware) Если задано значение true, результат авторизации будет содержать центр для домашнего облака пользователя, и этот центр будет использоваться для запроса токена вместо центра, заданного в приложении.
InteractiveRequestParametersBuilder	loginHint(String loginHint) Можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа для пользователя, если вы знаете имя пользователя или адрес электронной почты заранее.
InteractiveRequestParametersBuilder	prompt(Prompt prompt) Укажите тип необходимого взаимодействия с пользователем.
InteractiveRequestParametersBuilder	proofOfPossession(HttpMethod httpMethod, URI uri, String nonce) Задает параметры popдля этого запроса, позволяя запросу получать маркеры проверки владения, а не маркеры носителя.
InteractiveRequestParametersBuilder	redirectUri(URI redirectUri) URI перенаправления, в котором MSAL будет прослушивать код авторизации, возвращенный Azure AD.
InteractiveRequestParametersBuilder	scopes(Set<String> scopes) Области, к которым приложение запрашивает доступ, и пользователь даст согласие.
InteractiveRequestParametersBuilder	systemBrowserOptions(SystemBrowserOptions systemBrowserOptions) Наборы SystemBrowserOptions , используемые общедоступнымклиентскимприложением
InteractiveRequestParametersBuilder	tenant(String tenant) Переопределяет значение клиента в URL-адресе центра для этого запроса.
java.lang.String	toString()
InteractiveRequestParametersBuilder	windowHandle(long windowHandle) Дескриптор родительского окна, используемый для открытия элементов пользовательского интерфейса с правильным родительским элементом

Методы, унаследованные от 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

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

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Утверждения, запрашиваемые с помощью параметра запроса утверждений OIDC, разрешающие запросы на стандартные и пользовательские утверждения

Параметры:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Используется при сбое запроса маркера и ответ имеет строку вызова

Параметры:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

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

Параметры:

domainHint

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Добавляет дополнительные заголовки в запрос маркера

Параметры:

extraHttpHeaders

extraQueryParameters

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

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

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

Добавляет дополнительные параметры запроса в запрос маркера

Параметры:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

Время в секундах, которое библиотека ожидает результата проверки подлинности. 120 секунд — это время ожидания по умолчанию.

Если это время ожидания равно 0 или меньше, оно будет игнорироваться, а библиотека будет использовать 1-секундное время ожидания.

Параметры:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Если задано значение true, результат авторизации будет содержать центр для домашнего облака пользователя, и этот центр будет использоваться для запроса токена вместо центра, заданного в приложении.

Параметры:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Можно использовать для предварительного заполнения поля имени пользователя или электронной почты страницы входа для пользователя, если вы знаете имя пользователя или адрес электронной почты заранее. Часто приложения используют этот параметр во время повторной проверки подлинности, уже извлекая имя пользователя из предыдущего входа с помощью утверждения preferred_username.

Параметры:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Укажите тип необходимого взаимодействия с пользователем.

Параметры:

prompt

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Задает popParameters для этого запроса, позволяя запросу получать маркеры проверки владения, а не маркеры носителя.

Дополнительные сведения см. в разделе PopParameters и https://aka.ms/msal4j-pop

Параметры:

httpMethod - допустимый метод HTTP, например GET или POST.

uri - универсальный код ресурса (URI) в нижестоящем защищенном API, к которому приложение пытается получить доступ, например. https://graph.microsoft.com/beta/me/profile

nonce - Строка, полученная путем вызова ресурса (например, Microsoft Graph) без проверки подлинности и анализа заголовка WWW-Authenticate, связанного с схемой проверки подлинности pop, и извлечения параметра nonce или при последующих вызовах путем анализа заголовка Autheticate-Info и извлечения параметра nextnonce.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

URI перенаправления, в котором MSAL будет прослушивать код авторизации, возвращенный Azure AD. Должен быть адрес обратного цикла с указанным портом (например, http://localhost:3671). Если порт не указан, MSAL найдет открытый порт. Дополнительные сведения см. в разделе https://aka.ms/msal4j-interactive-request.

Не может быть пустым.

Параметры:

redirectUri

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)

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

Параметры:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Наборы SystemBrowserOptions , используемые PublicClientApplication

Параметры:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Переопределяет значение клиента в URL-адресе центра для этого запроса.

Параметры:

tenant

toString

public String toString()

Переопределения:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

Дескриптор родительского окна, используемый для открытия элементов пользовательского интерфейса с правильным родительским элементом

Для сценариев браузера и консольных приложений Windows это значение не должно быть задано.

Для консольных приложений Windows MSAL Java попытается обнаружить дескриптор окна консоли, если этот параметр не задан.

В сценариях, когда MSAL Java отвечает за открытие элементов пользовательского интерфейса (например, при использовании MSALRuntime), этот параметр требуется, и исключение будет создано, если не задано.

Параметры:

windowHandle