GoogleOptions Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Параметры конфигурации для GoogleHandler.
public ref class GoogleOptions : Microsoft::AspNetCore::Authentication::OAuth::OAuthOptions
public class GoogleOptions : Microsoft.AspNetCore.Authentication.OAuth.OAuthOptions
type GoogleOptions = class
inherit OAuthOptions
Public Class GoogleOptions
Inherits OAuthOptions
- Наследование
Конструкторы
GoogleOptions() |
Инициализирует новый объект GoogleOptions. |
Свойства
AccessDeniedPath |
Возвращает или задает необязательный путь, на который перенаправляется агент пользователя, если пользователь не утверждает требование авторизации, запрошенное удаленным сервером. Это свойство не задано по умолчанию. В этом случае исключение возникает, если удаленный сервер авторизации возвращает ответ access_denied. (Унаследовано от RemoteAuthenticationOptions) |
AccessType |
Указывает, может ли приложение обновлять маркеры доступа, если пользователь отсутствует в браузере.
Допустимые значения: Если приложению требуется обновить маркеры доступа, если пользователь отсутствует в браузере, задайте значение в автономном режиме. |
AuthorizationEndpoint |
Возвращает или задает URI, по которому клиент будет перенаправляться для проверки подлинности. (Унаследовано от OAuthOptions) |
Backchannel |
Используется для взаимодействия с удаленным поставщиком удостоверений. (Унаследовано от RemoteAuthenticationOptions) |
BackchannelHttpHandler |
HttpMessageHandler, используемый для взаимодействия с удаленным поставщиком удостоверений. Его нельзя задать одновременно с BackchannelCertificateValidator, если только значение не может быть получено нисходящим приведением WebRequestHandler. (Унаследовано от RemoteAuthenticationOptions) |
BackchannelTimeout |
Возвращает или задает значение времени ожидания в миллисекундах для связи обратного канала с удаленным поставщиком удостоверений. (Унаследовано от RemoteAuthenticationOptions) |
CallbackPath |
Путь запроса с базовым путем приложения, по которому будет возвращен агент пользователя. ПО промежуточного слоя обработает этот запрос после его поступления. (Унаследовано от RemoteAuthenticationOptions) |
ClaimActions |
Коллекция действий утверждений, используемых для выбора значений из пользовательских данных JSON и создания утверждений. (Унаследовано от OAuthOptions) |
ClaimsIssuer |
Возвращает или задает издателя, который должен использоваться для всех создаваемых утверждений. (Унаследовано от AuthenticationSchemeOptions) |
ClientId |
Возвращает или задает идентификатор клиента, назначаемого поставщиком. (Унаследовано от OAuthOptions) |
ClientSecret |
Возвращает или задает секрет клиента, назначаемый поставщиком. (Унаследовано от OAuthOptions) |
CorrelationCookie |
Определяет параметры, используемые для создания файла cookie корреляции перед добавлением файла cookie в ответ. (Унаследовано от RemoteAuthenticationOptions) |
DataProtectionProvider |
Возвращает или задает тип, используемый для защиты данных. (Унаследовано от RemoteAuthenticationOptions) |
Events |
Возвращает или задает объект , используемый OAuthEvents для обработки событий проверки подлинности. (Унаследовано от OAuthOptions) |
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) |
RemoteAuthenticationTimeout |
Возвращает или задает ограничение времени для выполнения потока проверки подлинности (15 минут по умолчанию). (Унаследовано от RemoteAuthenticationOptions) |
ReturnUrlParameter |
Возвращает или задает имя параметра, используемого для передачи исходного расположения пользователя до запуска удаленного запроса на страницу отказа в доступе. Это свойство используется только при явном указании AccessDeniedPath . (Унаследовано от RemoteAuthenticationOptions) |
SaveTokens |
Определяет, должны ли маркеры доступа и обновления храниться в AuthenticationProperties после успешной авторизации.
Это свойство по умолчанию имеет значение , |
Scope |
Возвращает список запрашиваемых разрешений. (Унаследовано от OAuthOptions) |
SignInScheme |
Возвращает или задает схему проверки подлинности, соответствующую ПО промежуточного слоя, отвечающему за сохранение удостоверения пользователя после успешной проверки подлинности. Это значение обычно соответствует ПО промежуточного слоя cookie, зарегистрированного в классе Startup. Если этот параметр опущен, DefaultSignInScheme используется в качестве резервного значения. (Унаследовано от RemoteAuthenticationOptions) |
StateDataFormat |
Получает или задает тип, используемый для защиты данных, обрабатываемых ПО промежуточного слоя. (Унаследовано от OAuthOptions) |
TimeProvider |
Используется для тестирования. (Унаследовано от AuthenticationSchemeOptions) |
TokenEndpoint |
Возвращает или задает универсальный код ресурса (URI), к котором ПО промежуточного слоя будет обращаться для обмена маркером OAuth. (Унаследовано от OAuthOptions) |
UsePkce |
Включает или отключает использование стандарта "Ключ проверки для обмена кодом" (PKCE). См. раздел https://tools.ietf.org/html/rfc7636.
Значение по умолчанию — , |
UserInformationEndpoint |
Возвращает или задает универсальный код ресурса (URI), к котором ПО промежуточного слоя будет обращаться для получения сведений о пользователе. Это значение не используется в реализации по умолчанию, оно предназначено для использования в пользовательских реализациях OnCreatingTicket. (Унаследовано от OAuthOptions) |
Методы
Validate() |
Убедитесь, что параметры допустимы. Если все не в порядке, должно вызываться исключение. (Унаследовано от OAuthOptions) |
Validate(String) |
Проверяет, допустимы ли параметры для конкретной схемы (Унаследовано от RemoteAuthenticationOptions) |
Применяется к
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по