UserFederatedIdentityCredentialParameters Класс

  • java.lang.Object
    • com.microsoft.aad.msal4j.UserFederatedIdentityCredentialParameters

Реализации

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Объект, содержащий параметры для потока учетных данных федеративного удостоверения пользователя (user_fic). Это используется для протокола удостоверений агента 3, где федеративные учетные данные удостоверения (полученные из Leg 2) обмениваются на маркер с областью действия пользователя.

Можно использовать в качестве параметра acquireToken(UserFederatedIdentityCredentialParameters parameters)

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

Модификатор и тип Метод и описание
java.lang.String assertion()
static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Построитель для UserFederatedIdentityCredentialParameters использования имени участника-пользователя (имя участника-пользователя).

static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Построитель для UserFederatedIdentityCredentialParameters использования идентификатора пользовательского объекта.

ClaimsRequest claims()

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

java.lang.String clientClaims()

Клиентские утверждения, заданные через UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String).

java.lang.String computeExtCacheKeyHash()

Вычисляет хэш расширенного ключа кэша из всех компонентов ключа кэша или пустую строку, если нет.

java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

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

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

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

Присутствует только для удовлетворения IAcquireTokenParameters контракта интерфейса. Не рекомендуется использовать — этот API планируется удалить во всех классах параметров и будет заменен новым механизмом в будущем выпуске.

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

boolean forceRefresh()
java.util.Set<java.lang.String> scopes()

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

java.lang.String tenant()

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

java.lang.String username()
java.util.UUID userObjectId()

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

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

assertion

public String assertion()

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

утверждение учетных данных федеративного удостоверения (JWT)

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Построитель для UserFederatedIdentityCredentialParameters использования имени участника-пользователя (имя участника-пользователя).

Параметры:

scopes - Приложение scopes запрашивает доступ к
username - имя участника-пользователя (например, "user@contoso.com")
assertion - утверждение учетных данных федеративного удостоверения (JWT), полученное из 2-го этапа

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

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

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Построитель для UserFederatedIdentityCredentialParameters использования идентификатора пользовательского объекта.

Параметры:

scopes - Приложение scopes запрашивает доступ к
userObjectId - Идентификатор объекта (OID) целевого пользователя
assertion - утверждение учетных данных федеративного удостоверения (JWT), полученное из 2-го этапа

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

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

claims

public ClaimsRequest claims()

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

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

clientClaims

public String clientClaims()

Клиентские утверждения, заданные через UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String). Перенаправляется в конечную точку токена в качестве параметра OAuth claims и используется в составе ключа расширенного кэша, чтобы отдельные значения утверждений кэшировались отдельно.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Вычисляет хэш расширенного ключа кэша из всех компонентов ключа кэша или пустую строку, если нет. Результат замечен, так как параметры неизменяемы после строительства.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

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

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

extraQueryParameters


public Map<String,String> extraQueryParameters()

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

Присутствует только для удовлетворения IAcquireTokenParameters контракта интерфейса. Не рекомендуется использовать — этот API планируется удалить во всех классах параметров и будет заменен новым механизмом в будущем выпуске.

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

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

forceRefresh

public boolean forceRefresh()

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

Следует ли обходить кэш маркеров и принудительно запрашивать новый маркер

scopes

public Set<String> scopes()

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

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

tenant

public String tenant()

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

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

username

public String username()

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

имя участника-пользователя или значение NULL, если пользователь был идентифицирован идентификатором объекта

userObjectId

public UUID userObjectId()

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

Идентификатор объекта целевого пользователя или значение NULL, если пользователь был определен в имени участника-пользователя.

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