OAuthOptions Класс

Определение

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

Microsoft.AspNetCore.Authentication.OAuth

Сборка:

Microsoft.AspNetCore.Authentication.OAuth.dll

Пакет:

Microsoft.AspNetCore.App.Ref v8.0.0

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

OAuthOptions.cs

Параметры конфигурации OAuth.

public ref class OAuthOptions : Microsoft::AspNetCore::Authentication::RemoteAuthenticationOptions

public class OAuthOptions : Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions

type OAuthOptions = class
    inherit RemoteAuthenticationOptions

Public Class OAuthOptions
Inherits RemoteAuthenticationOptions

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

Object

AuthenticationSchemeOptions

RemoteAuthenticationOptions

OAuthOptions

Производный

Microsoft.AspNetCore.Authentication.Facebook.FacebookOptions

Microsoft.AspNetCore.Authentication.Google.GoogleOptions

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountOptions

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

OAuthOptions()

Инициализирует новый экземпляр OAuthOptions.

Свойства

AccessDeniedPath	Возвращает или задает необязательный путь, по которому перенаправляется агент пользователя, если пользователь не утвердит запрос авторизации, запрошенный удаленным сервером. Это свойство не задано по умолчанию. В этом случае исключение возникает, если access_denied ответ возвращается сервером удаленной авторизации. (Унаследовано от RemoteAuthenticationOptions)
AuthorizationEndpoint	Возвращает или задает универсальный код ресурса (URI), в котором клиент будет перенаправлен для проверки подлинности.
Backchannel	Используется для взаимодействия с поставщиком удаленных удостоверений. (Унаследовано от RemoteAuthenticationOptions)
BackchannelHttpHandler	HttpMessageHandler используется для взаимодействия с поставщиком удаленных удостоверений. Это нельзя задать одновременно с BackchannelCertificateValidator, если значение не может быть переадресовано в WebRequestHandler. (Унаследовано от RemoteAuthenticationOptions)
BackchannelTimeout	Возвращает или задает значение времени ожидания в миллисекундах для обмена данными с удаленным поставщиком удостоверений. (Унаследовано от RemoteAuthenticationOptions)
CallbackPath	Путь запроса в базовом пути приложения, в котором будет возвращен пользователь-агент. ПО промежуточного слоя обрабатывает этот запрос при поступлении. (Унаследовано от RemoteAuthenticationOptions)
ClaimActions	Коллекция действий утверждений, используемых для выбора значений из пользовательских данных json и создания утверждений.
ClaimsIssuer	Возвращает или задает издателя, который должен использоваться для всех созданных утверждений. (Унаследовано от AuthenticationSchemeOptions)
ClientId	Возвращает или задает идентификатор клиента, назначаемого поставщиком.
ClientSecret	Возвращает или задает секрет клиента, назначенный поставщиком.
CorrelationCookie	Определяет параметры, используемые для создания файла cookie корреляции перед добавлением файла cookie в ответ. (Унаследовано от RemoteAuthenticationOptions)
DataProtectionProvider	Возвращает или задает тип, используемый для защиты данных. (Унаследовано от RemoteAuthenticationOptions)
Events	Возвращает или задает OAuthEvents, используемый для обработки событий проверки подлинности.
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)
RemoteAuthenticationTimeout	Возвращает или задает ограничение времени для завершения потока проверки подлинности (15 минут по умолчанию). (Унаследовано от RemoteAuthenticationOptions)
ReturnUrlParameter	Возвращает или задает имя параметра, используемого для передачи исходного расположения пользователя до запуска удаленной задачи до страницы отказа доступа. Это свойство используется только при явном указании AccessDeniedPath. (Унаследовано от RemoteAuthenticationOptions)
SaveTokens	Определяет, следует ли хранить маркеры доступа и обновления в AuthenticationProperties после успешной авторизации. Это свойство имеет значение false по умолчанию, чтобы уменьшить размер окончательного файла cookie проверки подлинности. (Унаследовано от RemoteAuthenticationOptions)
Scope	Возвращает список разрешений для запроса.
SignInScheme	Возвращает или задает схему проверки подлинности, соответствующую ПО промежуточного слоя, ответственному за сохранение удостоверения пользователя после успешной проверки подлинности. Обычно это значение соответствует ПО промежуточного слоя cookie, зарегистрированного в классе Startup. Если опущено, DefaultSignInScheme используется в качестве резервного значения. (Унаследовано от RemoteAuthenticationOptions)
StateDataFormat	Возвращает или задает тип, используемый для защиты данных, обрабатываемых ПО промежуточного слоя.
TimeProvider	Используется для тестирования. (Унаследовано от AuthenticationSchemeOptions)
TokenEndpoint	Получает или задает универсальный код ресурса (URI), который по промежуточному слоям будет обращаться к маркеру OAuth.
UsePkce	Включает или отключает использование стандартного ключа проверки правописания для Exchange (PKCE). См. https://tools.ietf.org/html/rfc7636. Значение по умолчанию — false, но производные обработчики должны включить это, если его поддерживает их поставщик.
UserInformationEndpoint	Получает или задает универсальный код ресурса (URI), к котором по промежуточному слоям будет получен доступ для получения сведений о пользователе. Это значение не используется в реализации по умолчанию, оно предназначено для использования в пользовательских реализациях OnCreatingTicket.

Методы

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