Поделиться через


OpenIdConnectOptions Класс

Определение

Параметры конфигурации для OpenIdConnectMiddleware

public ref class OpenIdConnectOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions
public class OpenIdConnectOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions
type OpenIdConnectOptions = class
    inherit RemoteAuthenticationOptions
Public Class OpenIdConnectOptions
Inherits RemoteAuthenticationOptions
Наследование

Конструкторы

OpenIdConnectOptions()

Инициализирует новый OpenIdConnectOptions.

OpenIdConnectOptions(String)

Инициализирует новый OpenIdConnectOptions.

Свойства

AuthenticationMethod

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

AuthenticationScheme

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

(Унаследовано от AuthenticationOptions)
Authority

Получает или задает полномочия для использования при выполнении вызовов OpenIdConnect.

AutomaticAuthenticate

Если значение равно true, ПО промежуточного слоя для проверки подлинности изменит запрос пользователя. Если задано значение false, ПО промежуточного слоя для проверки подлинности будет предоставлять удостоверение только при явном указании AuthenticationScheme.

(Унаследовано от AuthenticationOptions)
AutomaticChallenge

Если значение равно true, ПО промежуточного слоя проверки подлинности должно обрабатывать автоматический запрос. Если значение равно false, ПО промежуточного слоя для проверки подлинности изменит ответы только при явном указании AuthenticationScheme.

(Унаследовано от AuthenticationOptions)
BackchannelHttpHandler

HttpMessageHandler, используемый для взаимодействия с удаленным поставщиком удостоверений. Его нельзя задать одновременно с BackchannelCertificateValidator, если только значение не может быть получено нисходящим приведением WebRequestHandler.

(Унаследовано от RemoteAuthenticationOptions)
BackchannelTimeout

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

(Унаследовано от RemoteAuthenticationOptions)
CallbackPath

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

(Унаследовано от RemoteAuthenticationOptions)
ClaimsIssuer

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

(Унаследовано от AuthenticationOptions)
ClientId

Получает или задает "client_id".

ClientSecret

Получает или задает "client_secret".

Configuration

Конфигурация, предоставленная напрямую от разработчика. Если она предоставлена, то свойства MetadataAddress и Backchannel не используются. Эти сведения не должны обновляться во время обработки запроса.

ConfigurationManager

Отвечает за получение, кэширование и обновление конфигурации из метаданных. Если не предоставлено, то будет создано с помощью свойств MetadataAddress и Backchannel.

Description

Дополнительная информация о типе проверки подлинности, доступная в приложении.

(Унаследовано от AuthenticationOptions)
DisplayName

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

(Унаследовано от RemoteAuthenticationOptions)
Events

Возвращает или задает объект для IOpenIdConnectEvents уведомления при обработке сообщений OpenIdConnect.

GetClaimsFromUserInfoEndpoint

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

MetadataAddress

Получает или задает конечную точку обнаружения для получения метаданных

PostLogoutRedirectUri

Универсальный код ресурса (URI), в который будет возвращен агент пользователя после выхода приложения из поставщика удостоверений. Перенаправление произойдет после вызова SignedOutCallbackPath.

ProtocolValidator

Возвращает или задает объект , OpenIdConnectProtocolValidator который используется для обеспечения допустимости полученного id_token для: http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation

RefreshOnIssuerKeyNotFound

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

RemoteAuthenticationTimeout

Возвращает или задает ограничение времени для завершения потока проверки подлинности (15 минут по умолчанию).

(Унаследовано от RemoteAuthenticationOptions)
RemoteSignOutPath

Запросы, полученные по этому пути, приведут к тому, что ПО промежуточного слоя вызовет SignOut с помощью SignInScheme.

RequireHttpsMetadata

Возвращает или задает значение , если для адреса или центра метаданных требуется ПРОТОКОЛ HTTPS. Значение по умолчанию — true. Эта функция должна быть отключена только в средах разработки.

Resource

Получает или задает "resource".

ResponseMode

Возвращает или задает response_mode.

ResponseType

Получает или задает "response_type".

SaveTokens

Определяет, должны ли маркеры доступа и обновления храниться в AuthenticationProperties после успешной авторизации. Это свойство по умолчанию имеет значение , false чтобы уменьшить размер окончательного файла cookie проверки подлинности.

(Унаследовано от RemoteAuthenticationOptions)
Scope

Возвращает список запрашиваемых разрешений.

SecurityTokenValidator

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

SignedOutCallbackPath

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

SignInScheme

Возвращает или задает схему проверки подлинности, соответствующую ПО промежуточного слоя, ответственному за сохранение удостоверения пользователя после успешной проверки подлинности. Это значение обычно соответствует ПО промежуточного слоя cookie, зарегистрированное в классе Startup. Если этот параметр опущен, SignInScheme используется в качестве резервного значения.

(Унаследовано от RemoteAuthenticationOptions)
SignOutScheme

Схема проверки подлинности, используемая с SignOut в SignOutPath. Если этот параметр не задан, будет использоваться SignInScheme.

SkipUnrecognizedRequests

Указывает, могут ли запросы к CallbackPath также быть для других компонентов. Если этот параметр включен, ПО промежуточного слоя будет передавать запросы, которые не содержат ответов проверки подлинности OpenIdConnect. Отключение этого параметра и установка для callbackPath выделенной конечной точки может улучшить обработку ошибок. Эта функция отключена по умолчанию.

StateDataFormat

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

StringDataFormat

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

SystemClock

Только для тестирования.

SystemClock

Только для тестирования.

(Унаследовано от AuthenticationOptions)
TokenValidationParameters

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

UseTokenLifetime

Указывает, что время существования сеанса проверки подлинности (например, файлы cookie) должно совпадать со временем существования маркера проверки подлинности. Если токен не содержит сведений о времени жизни, тогда используется нормальное время жизни сеанса. Эта функция отключена по умолчанию.

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