OpenIdConnectOptions Класс

Определение

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

Microsoft.AspNetCore.Authentication.OpenIdConnect

Сборка:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

Пакет:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

Исходный код:

OpenIdConnectOptions.cs

Параметры конфигурации для 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	Конфигурация, предоставляемая разработчиком напрямую. Если задано, метаданныеAddress и свойства 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, за которым следует ForwardDefaultSelector. Первый непустой результат будет использоваться в качестве целевой схемы для перенаправления. (Унаследовано от AuthenticationSchemeOptions)
ForwardDefaultSelector	Используется для выбора схемы по умолчанию для текущего запроса, в который обработчики проверки подлинности должны пересылать все операции проверки подлинности по умолчанию. Логика переадресации по умолчанию проверяет наиболее конкретный параметр ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, а затем проверит параметр ForwardDefaultSelector, за которым следует ForwardDefaultSelector. Первый непустой результат будет использоваться в качестве целевой схемы для перенаправления. (Унаследовано от 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	Возвращает или задает свойство MapInboundClaims экземпляра JwtSecurityTokenHandler по умолчанию в SecurityTokenValidator и экземпляре JsonWebTokenHandler по умолчанию в TokenHandler, которое используется при определении того, следует ли сопоставлять типы утверждений, извлеченные при проверке JwtSecurityToken. Если задано значение true, тип утверждения задается для утверждения JSON "name" после перевода с помощью этого сопоставления. В противном случае сопоставление не выполняется. Значение по умолчанию — true.
MaxAge	Возвращает или задает значение "max_age". Если задать параметр "max_age", будет отправлен запрос проверки подлинности. Если поставщик удостоверений не прошел активную проверку подлинности пользователя в течение указанного времени, пользователю будет предложено повторно пройти проверку подлинности. По умолчанию max_age не указан.
MetadataAddress	Возвращает или задает конечную точку обнаружения для получения метаданных
NonceCookie	Определяет параметры, используемые для создания файла cookie nonce перед добавлением файла cookie в ответ.
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	Возвращает или задает ресурс.
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, если UseSecurityTokenValidatorfalse.
TokenValidationParameters	Возвращает или задает параметры, используемые для проверки маркеров удостоверений.
UsePkce	Включает или отключает использование стандартного ключа проверки правописания для Exchange (PKCE). Это применяется только в том случае, если для ResponseType задано значение Code. См. https://tools.ietf.org/html/rfc7636. Значение по умолчанию — true.
UseSecurityTokenValidator	Возвращает или задает, следует ли использовать TokenHandler или SecurityTokenValidator для проверки маркеров идентификации.
UseTokenLifetime	Указывает, что время существования сеанса проверки подлинности (например, cookie) должно соответствовать времени существования маркера проверки подлинности. Если маркер не предоставляет сведения о времени существования, будет использоваться обычное время существования сеанса. Эта функция отключена по умолчанию.

Методы

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