OpenIdConnectOptions Класс

Определение

Пространство имен:

Microsoft.AspNetCore.Authentication.OpenIdConnect

Сборка:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Пакет:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Параметры конфигурации для 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

Наследование

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OpenIdConnectOptions

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

OpenIdConnectOptions()

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

Свойства

AccessDeniedPath	Возвращает или задает необязательный путь, на который перенаправляется агент пользователя, если пользователь не утверждает запрос на авторизацию, запрошенный удаленным сервером. Это свойство не задано по умолчанию. В этом случае исключение возникает, если удаленный сервер авторизации возвращает ответ access_denied. (Унаследовано от RemoteAuthenticationOptions)
AuthenticationMethod	Возвращает или задает метод, используемый для перенаправления агента пользователя к поставщику удостоверений.
Authority	Получает или задает полномочия для использования при выполнении вызовов OpenIdConnect.
AutomaticRefreshInterval	Возвращает или задает частоту автоматического обновления метаданных.
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	Если задано значение , будет использоваться в качестве типа службы для получения экземпляра Events вместо свойства . (Унаследовано от AuthenticationSchemeOptions)
ForwardAuthenticate	Если задано значение , это указывает целевую схему, в которую эта схема должна пересылать вызовы AuthenticateAsync. Например, Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку. (Унаследовано от AuthenticationSchemeOptions)
ForwardChallenge	Если задано значение , это указывает целевую схему, в которую эта схема должна переадресовывать вызовы ChallengeAsync. Например, Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку. (Унаследовано от AuthenticationSchemeOptions)
ForwardDefault	Если задано значение , это указывает схему по умолчанию, в которую обработчики проверки подлинности должны перенаправлять все операции проверки подлинности по умолчанию. Логика переадресации по умолчанию сначала проверка самый конкретный параметр ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, а затем проверка ForwardDefaultSelector, а затем ForwardDefault. Первый результат, отличный от NULL, будет использоваться в качестве целевой схемы для пересылки. (Унаследовано от AuthenticationSchemeOptions)
ForwardDefaultSelector	Используется для выбора схемы по умолчанию для текущего запроса, в который обработчики проверки подлинности должны пересылать все операции проверки подлинности по умолчанию. Логика переадресации по умолчанию сначала проверка самый конкретный параметр ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, а затем проверка ForwardDefaultSelector, а затем ForwardDefault. Первый результат, отличный от NULL, будет использоваться в качестве целевой схемы для пересылки. (Унаследовано от AuthenticationSchemeOptions)
ForwardForbid	Если задано значение , это указывает целевую схему, в которую эта схема должна пересылать вызовы ForbidAsync. Например, Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку. (Унаследовано от AuthenticationSchemeOptions)
ForwardSignIn	Если задано значение , то указывает целевую схему, в которую эта схема должна пересылать вызовы SignInAsync. Например, Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку. (Унаследовано от AuthenticationSchemeOptions)
ForwardSignOut	Если задано значение , это указывает целевую схему, в которую эта схема должна пересылать вызовы SignOutAsync. Например, Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку. (Унаследовано от AuthenticationSchemeOptions)
GetClaimsFromUserInfoEndpoint	Логическое значение, указывающее, должен ли обработчик переходить к конечной точке сведений о пользователе для получения дополнительных утверждений или нет после создания удостоверения из id_token, полученных от конечной точки маркера. Значение по умолчанию — false.
MapInboundClaims	Возвращает или задает свойство экземпляра MapInboundClaimsJwtSecurityTokenHandler по умолчанию в SecurityTokenValidator и экземпляр по JsonWebTokenHandler умолчанию в TokenHandler, который используется при определении того, следует ли сопоставлять типы утверждений, извлеченные при проверке JwtSecurityToken. Если задано значение true, для параметра Тип утверждения устанавливается утверждение JSON "name" после перевода с помощью этого сопоставления. В противном случае сопоставление не выполняется. Значение по умолчанию — 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	Возвращает или задает минимальное время между извлечениями в случае сбоя извлечения или явного запроса на обновление.
RefreshOnIssuerKeyNotFound	Получает или задает значение, указывающее, должна ли выполняться попытка обновить метаданные после SecurityTokenSignatureKeyNotFoundException. Это позволяет выполнять автоматическое восстановление при смене ключей подписи. Эта функция включена по умолчанию.
RemoteAuthenticationTimeout	Возвращает или задает ограничение времени для выполнения потока проверки подлинности (15 минут по умолчанию). (Унаследовано от RemoteAuthenticationOptions)
RemoteSignOutPath	Запросы, полученные по этому пути, приведут к тому, что обработчик вызовет SignOut с помощью SignOutScheme.
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), на который будет перенаправляться агент пользователя после выхода приложения из поставщика удостоверений. Перенаправление произойдет после вызова SignedOutCallbackPath.
SignInScheme	Возвращает или задает схему проверки подлинности, соответствующую ПО промежуточного слоя, отвечающему за сохранение удостоверения пользователя после успешной проверки подлинности. Это значение обычно соответствует ПО промежуточного слоя cookie, зарегистрированного в классе Startup. Если этот параметр опущен, DefaultSignInScheme используется в качестве резервного значения. (Унаследовано от RemoteAuthenticationOptions)
SignOutScheme	Схема проверки подлинности, используемая с SignOut в SignOutPath. Если этот параметр не задан, будет использоваться SignInScheme.
SkipUnrecognizedRequests	Указывает, могут ли запросы к CallbackPath также быть для других компонентов. Если этот параметр включен, обработчик будет передавать запросы, не содержащие ответы проверки подлинности OpenIdConnect. Отключение этого параметра и установка для callbackPath выделенной конечной точки может улучшить обработку ошибок. Эта функция отключена по умолчанию.
StateDataFormat	Возвращает или задает тип, используемый для защиты данных, обрабатываемых обработчиком.
StringDataFormat	Возвращает или задает тип, используемый для защиты строк, используемых обработчиком.
TimeProvider	Используется для тестирования. (Унаследовано от AuthenticationSchemeOptions)
TokenHandler	Возвращает или задает объект , используемый TokenHandler для проверки маркеров удостоверений. Он будет использоваться вместо , SecurityTokenValidator если UseSecurityTokenValidator имеет значение false.
TokenValidationParameters	Возвращает или задает параметры, используемые для проверки маркеров удостоверений.
UsePkce	Включает или отключает использование стандарта "Ключ проверки для обмена кодом" (PKCE). Это применимо только в том случае, ResponseType если для задано значение Code. См. раздел https://tools.ietf.org/html/rfc7636. Значение по умолчанию — true.
UseSecurityTokenValidator	Возвращает или задает значение, указывающее TokenHandler , следует ли использовать или для SecurityTokenValidator проверки маркеров удостоверений.
UseTokenLifetime	Указывает, что время существования сеанса проверки подлинности (например, файлы cookie) должно совпадать со временем существования маркера проверки подлинности. Если токен не содержит сведений о времени жизни, тогда используется нормальное время жизни сеанса. Эта функция отключена по умолчанию.

Методы

Validate()	Убедитесь, что параметры являются допустимыми. Должен вызывать исключение, если все не в порядке.
Validate(String)	Проверяет, допустимы ли параметры для конкретной схемы (Унаследовано от RemoteAuthenticationOptions)