OpenIdConnectOptions Класс

Определение

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

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

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

OpenIdConnectOptions()

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

Свойства

AccessDeniedPath

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

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

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

Authority

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

AutomaticRefreshInterval

1 день — это интервал времени по умолчанию, который затем ConfigurationManager будет получать новую конфигурацию.

Backchannel

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

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

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

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

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

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

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

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

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

ClaimsIssuer

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

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

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

ClientSecret

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

Configuration

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

ConfigurationManager

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

CorrelationCookie

Определяет параметры, используемые для создания файла cookie корреляции перед добавлением файла cookie в ответ.

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

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

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

Указывает, следует ли отключать телеметрию. если эта функция включена, версия сборки пакетов Microsoft IdentityModel отправляется в поставщик удаленного openid connect Подключение как параметр запроса авторизации/выхода.

Events

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

EventsType

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

(Унаследовано от AuthenticationSchemeOptions)
ForwardAuthenticate

Если задано значение, это указывает целевую схему, на которую эта схема должна пересылать вызовы AuthenticateAsync. Например, context. AuthenticateAsync ("Сиссчеме") = > context. AuthenticateAsync ("форвардаусентикатевалуе"); Задайте в качестве целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

(Унаследовано от AuthenticationSchemeOptions)
ForwardChallenge

Если задано значение, это указывает целевую схему, на которую эта схема должна пересылать вызовы Чалленжеасинк. Например, context. Чалленжеасинк ("Сиссчеме") = > context. чалленжеасинк ("форвардчалленжевалуе"); Задайте в качестве целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

(Унаследовано от AuthenticationSchemeOptions)
ForwardDefault

Если задано значение, это указывает схему по умолчанию, которую обработчики проверки подлинности должны перенаправить все операции аутентификации по умолчанию. Логика переадресации по умолчанию сначала проверит наиболее конкретный параметр Форвардаусентикате/Challenge/запрета/входа/выхода, а затем проверяет Форварддефаултселектор, а затем Форварддефаулт. Первый результат, отличный от NULL, будет использоваться в качестве целевой схемы для пересылки.

(Унаследовано от AuthenticationSchemeOptions)
ForwardDefaultSelector

Используется для выбора схемы по умолчанию для текущего запроса, по умолчанию по которым обработчики проверки подлинности должны пересылать все операции аутентификации. Логика переадресации по умолчанию сначала проверит наиболее конкретный параметр Форвардаусентикате/Challenge/запрета/входа/выхода, а затем проверяет Форварддефаултселектор, а затем Форварддефаулт. Первый результат, отличный от NULL, будет использоваться в качестве целевой схемы для пересылки.

(Унаследовано от AuthenticationSchemeOptions)
ForwardForbid

Если задано значение, это указывает целевую схему, на которую эта схема должна пересылать вызовы Форбидасинк. Например, context. Форбидасинк ("Сиссчеме") = > context. форбидасинк ("форвардфорбидвалуе"); Задайте в качестве целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

(Унаследовано от AuthenticationSchemeOptions)
ForwardSignIn

Если задано значение, это указывает целевую схему, на которую эта схема должна пересылать вызовы Сигнинасинк. Например, context. Сигнинасинк ("Сиссчеме") = > context. сигнинасинк ("форвардсигнинвалуе"); Задайте в качестве целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

(Унаследовано от AuthenticationSchemeOptions)
ForwardSignOut

Если задано значение, это указывает целевую схему, на которую эта схема должна пересылать вызовы Сигнаутасинк. Например, context. Сигнаутасинк ("Сиссчеме") = > context. сигнаутасинк ("форвардсигнаутвалуе"); Задайте в качестве целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

(Унаследовано от AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint

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

MapInboundClaims

Возвращает или задает MapInboundClaims свойство для экземпляра по умолчанию JwtSecurityTokenHandler в секурититокенвалидатор, которое используется при определении, следует ли сопоставлять типы утверждений, извлекаемые при проверке JwtSecurityToken .

Если задано значение true, для типа утверждения задается утверждение JSON "имя" после преобразования с помощью этого сопоставления. В противном случае сопоставление не выполняется.

Значение по умолчанию — true.

MaxAge

Возвращает или задает "max_age". Если задать параметр "max_age", будет отправлен запрос на проверку подлинности. Если поставщик удостоверений не прошел проверку подлинности пользователя в течение указанного промежутка времени, пользователю будет предложено выполнить повторную проверку подлинности. По умолчанию max_age не указано.

MetadataAddress

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

NonceCookie

Определяет параметры, используемые для создания файла cookie nonce перед добавлением файла cookie в ответ.

Prompt

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

ProtocolValidator

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

RefreshInterval

Минимальное время между ConfigurationManager получением в случае сбоя извлечения или явного запроса обновления. по умолчанию используется значение 30 секунд.

RefreshOnIssuerKeyNotFound

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

RemoteAuthenticationTimeout

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

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

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

RequireHttpsMetadata

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

Resource

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

ResponseMode

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

ResponseType

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

ReturnUrlParameter

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

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

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

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

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

SecurityTokenValidator

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

SignedOutCallbackPath

Путь запроса в базовом пути приложения, по которому будет возвращен агент пользователя после выхода из поставщика удостоверений. См. post_logout_redirect_uri из http://openid.net/specs/openid-connect-session-1_0.html#RedirectionAfterLogout .

SignedOutRedirectUri

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

SignInScheme

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

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

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

SkipUnrecognizedRequests

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

StateDataFormat

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

StringDataFormat

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

TokenValidationParameters

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

UsePkce

включает или отключает использование ключа подтверждения для стандарта Code Exchange (PKCE) standard. Применяется только в том случае, если свойство ResponseType имеет значение Code . См. раздел https://tools.ietf.org/html/rfc7636. Значение по умолчанию — true.

UseTokenLifetime

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

Методы

Validate()

Проверьте правильность параметров. Если неверно, должно вызываться исключение.

Validate(String)

Проверяет, допустимы ли параметры для определенной схемы

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

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