ClientCredentialParameters Класс

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

Реализации

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Объект, содержащий параметры для потока учетных данных клиента. Можно использовать в качестве параметра acquireToken(ClientCredentialParameters parameters)

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

Модификатор и тип Метод и описание
static ClientCredentialParametersBuilder builder(Set<String> scopes)

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

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

Клиентские утверждения, заданные через ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential clientCredential()
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()

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

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

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

Возвращает путь FMI (федеративное управляемое удостоверение) для сценариев удостоверений агента.
java.util.Set<java.lang.String> scopes()

Возвращает набор областей (разрешений), запрошенных для маркера доступа.
java.lang.Boolean skipCache()
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 ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)

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

Параметры:

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

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

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

claims

public ClaimsRequest claims()

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

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

clientClaims

public String clientClaims()

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

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

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

Результат замечен, так как ClientCredentialParameters неизменяем после строительства. Используется для операций записи кэша () и операций чтения кэша (TokenCacheавтоматического поиска).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

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

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

extraQueryParameters


public Map<String,String> extraQueryParameters()

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

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

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

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

fmiPath

public String fmiPath()

Возвращает путь FMI (федеративное управляемое удостоверение) для сценариев удостоверений агента. При установке fmi_path отправляется в качестве параметра текста в запросе маркера учетных данных клиента, который ограничивает полученный маркер определенным удостоверением агента.

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

Путь FMI или null, если не задан

scopes

public Set<String> scopes()

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

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

skipCache

public Boolean skipCache()

tenant

public String tenant()

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

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

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