SiteAuthSettings Класс

Параметры конфигурации для функции проверки подлинности и авторизации Служба приложений Azure.

Переменные заполняются только сервером и игнорируются при отправке запроса.

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

azure.mgmt.web.v2019_08_01.models._models_py3.ProxyOnlyResource

SiteAuthSettings

Конструктор

SiteAuthSettings(*, kind: str | None = None, enabled: bool | None = None, runtime_version: str | None = None, unauthenticated_client_action: str | _models.UnauthenticatedClientAction | None = None, token_store_enabled: bool | None = None, allowed_external_redirect_urls: List[str] | None = None, default_provider: str | _models.BuiltInAuthenticationProvider | None = None, token_refresh_extension_hours: float | None = None, client_id: str | None = None, client_secret: str | None = None, client_secret_certificate_thumbprint: str | None = None, issuer: str | None = None, validate_issuer: bool | None = None, allowed_audiences: List[str] | None = None, additional_login_params: List[str] | None = None, google_client_id: str | None = None, google_client_secret: str | None = None, google_o_auth_scopes: List[str] | None = None, facebook_app_id: str | None = None, facebook_app_secret: str | None = None, facebook_o_auth_scopes: List[str] | None = None, twitter_consumer_key: str | None = None, twitter_consumer_secret: str | None = None, microsoft_account_client_id: str | None = None, microsoft_account_client_secret: str | None = None, microsoft_account_o_auth_scopes: List[str] | None = None, **kwargs: Any)

Параметры Keyword-Only

Имя	Описание
kind	str Тип ресурса.
enabled	bool <code>true</code> Значение , если для текущего приложения включена функция проверки подлинности и авторизации; в противном случае — <code>false</code>.
runtime_version	str RuntimeVersion функции проверки подлинности и авторизации, используемой для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле Проверка подлинности и авторизация.
unauthenticated_client_action	str или UnauthenticatedClientAction Действие, выполняемое при попытке клиента без проверки подлинности получить доступ к приложению. Известные значения: RedirectToLoginPage и AllowAnonymous.
token_store_enabled	bool <code>true</code> для надежного хранения маркеров безопасности для конкретной платформы, получаемых во время потоков входа; в противном случае — <code>false</code>. Значение по умолчанию — <code>false</code>.
allowed_external_redirect_urls	list[str] Внешние URL-адреса, на которые можно перенаправляться при входе в приложение или выходе из него. Обратите внимание, что часть строки запроса в URL-адресе игнорируется. Это расширенный параметр, который обычно требуется только для серверной части приложений Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены.
default_provider	str или BuiltInAuthenticationProvider Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим, только если настроено несколько поставщиков и для действия клиента без проверки подлинности задано значение RedirectToLoginPage. Известные значения: AzureActiveDirectory, Facebook, Google, MicrosoftAccount и Twitter.
token_refresh_extension_hours	float Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. По умолчанию — 72 часа.
client_id	str Идентификатор клиента этого приложения проверяющей стороны, известный как client_id. Этот параметр необходим для включения проверки подлинности Подключения OpenID с помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения об OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str Секрет клиента этого приложения проверяющей стороны (в Azure Active Directory это также называется ключом). Это необязательный параметр. Если секрет клиента не настроен, для проверки подлинности конечных пользователей используется неявный поток проверки подлинности OpenID Connect. В противном случае поток кода авторизации OpenID Connect используется для проверки подлинности конечных пользователей. Дополнительные сведения об OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_certificate_thumbprint	str Альтернатива секрету клиента, то есть отпечатку сертификата, используемого для подписывания. Это свойство служит заменой секрета клиента. Он также является необязательным.
issuer	str URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения. При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например https://sts.windows.net/{tenant-guid}/. Этот универсальный код ресурса (URI) является идентификатором с учетом регистра для издателя маркера. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Возвращает значение, указывающее, должен ли издатель быть допустимым URL-адресом HTTPS и проверяться как таковой.
allowed_audiences	list[str] Допустимые значения аудитории, которые следует учитывать при проверке JWT, выданных Azure Active Directory. Обратите внимание, что <code>ClientID</code> значение всегда считается разрешенной аудиторией, независимо от этого параметра.
additional_login_params	list[str] Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен иметь вид "key=value".
google_client_id	str Идентификатор клиента OpenID Connect для веб-приложения Google. Этот параметр необходим для включения входа в Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/.
google_client_secret	str Секрет клиента, связанный с веб-приложением Google. Этот параметр необходим для включения входа в Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/.
google_o_auth_scopes	list[str] Области OAuth 2.0, которые будут запрошены в рамках проверки подлинности Google Sign-In. Это необязательный параметр. Если не указано, в качестве областей по умолчанию используются openid, profile и email. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str Идентификатор приложения Facebook, используемого для входа. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str Секрет приложения Facebook, используемого для входа в Facebook. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login.
facebook_o_auth_scopes	list[str] Области OAuth 2.0, которые будут запрошены в рамках проверки подлинности входа в Facebook. Это необязательный параметр. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login.
twitter_consumer_key	str Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация по Sign-In Twitter: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str Секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация по Sign-In Twitter: https://dev.twitter.com/web/sign-in.
microsoft_account_client_id	str Идентификатор клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth для учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str Секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth для учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_o_auth_scopes	list[str] Области OAuth 2.0, которые будут запрошены в рамках проверки подлинности учетной записи Майкрософт. Это необязательный параметр. Если значение не указано, в качестве область по умолчанию используется wl.basic. Документация по областям и разрешениям учетной записи Майкрософт: https://msdn.microsoft.com/en-us/library/dn631845.aspx.

Переменные

Имя	Описание
id	str Идентификатор ресурса.
name	str Имя ресурса.
kind	str Тип ресурса.
type	str Тип ресурса.
enabled	bool <code>true</code> Значение , если для текущего приложения включена функция проверки подлинности и авторизации; в противном случае — <code>false</code>.
runtime_version	str RuntimeVersion функции проверки подлинности и авторизации, используемой для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле Проверка подлинности и авторизация.
unauthenticated_client_action	str или UnauthenticatedClientAction Действие, выполняемое при попытке клиента без проверки подлинности получить доступ к приложению. Известные значения: RedirectToLoginPage и AllowAnonymous.
token_store_enabled	bool <code>true</code> для надежного хранения маркеров безопасности для конкретной платформы, получаемых во время потоков входа; в противном случае — <code>false</code>. Значение по умолчанию — <code>false</code>.
allowed_external_redirect_urls	list[str] Внешние URL-адреса, на которые можно перенаправляться при входе в приложение или выходе из него. Обратите внимание, что часть строки запроса в URL-адресе игнорируется. Это расширенный параметр, который обычно требуется только для серверной части приложений Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены.
default_provider	str или BuiltInAuthenticationProvider Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим, только если настроено несколько поставщиков и для действия клиента без проверки подлинности задано значение RedirectToLoginPage. Известные значения: AzureActiveDirectory, Facebook, Google, MicrosoftAccount и Twitter.
token_refresh_extension_hours	float Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. По умолчанию — 72 часа.
client_id	str Идентификатор клиента этого приложения проверяющей стороны, известный как client_id. Этот параметр необходим для включения проверки подлинности Подключения OpenID с помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения об OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str Секрет клиента этого приложения проверяющей стороны (в Azure Active Directory это также называется ключом). Это необязательный параметр. Если секрет клиента не настроен, для проверки подлинности конечных пользователей используется неявный поток проверки подлинности OpenID Connect. В противном случае поток кода авторизации OpenID Connect используется для проверки подлинности конечных пользователей. Дополнительные сведения об OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_certificate_thumbprint	str Альтернатива секрету клиента, то есть отпечатку сертификата, используемого для подписывания. Это свойство служит заменой секрета клиента. Он также необязателен.
issuer	str URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения. При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например https://sts.windows.net/{tenant-guid}/. Этот универсальный код ресурса (URI) является идентификатором с учетом регистра для издателя маркера. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Возвращает значение, указывающее, должен ли издатель быть допустимым URL-адресом HTTPS и проверяться как таковой.
allowed_audiences	list[str] Допустимые значения аудитории, которые следует учитывать при проверке JWT, выданных Azure Active Directory. Обратите внимание, что <code>ClientID</code> значение всегда считается разрешенной аудиторией, независимо от этого параметра.
additional_login_params	list[str] Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен иметь вид "key=value".
google_client_id	str Идентификатор клиента OpenID Connect для веб-приложения Google. Этот параметр необходим для включения входа в Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/.
google_client_secret	str Секрет клиента, связанный с веб-приложением Google. Этот параметр необходим для включения входа в Google. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/.
google_o_auth_scopes	list[str] Области OAuth 2.0, которые будут запрошены в рамках проверки подлинности Google Sign-In. Это необязательный параметр. Если не указано, в качестве областей по умолчанию используются openid, profile и email. Документация по Google Sign-In: https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str Идентификатор приложения Facebook, используемого для входа. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str Секрет приложения Facebook, используемого для входа в Facebook. Этот параметр необходим для включения входа в Facebook. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login.
facebook_o_auth_scopes	list[str] Области OAuth 2.0, которые будут запрошены в рамках проверки подлинности входа в Facebook. Это необязательный параметр. Документация по входу в Facebook: https://developers.facebook.com/docs/facebook-login.
twitter_consumer_key	str Ключ потребителя OAuth 1.0a приложения Twitter, используемый для входа. Этот параметр необходим для включения входа в Twitter. Документация по Twitter Sign-In: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str Секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация по Twitter Sign-In: https://dev.twitter.com/web/sign-in.
microsoft_account_client_id	str Идентификатор клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth для учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str Секрет клиента OAuth 2.0, созданный для приложения, используемого для проверки подлинности. Этот параметр необходим для включения проверки подлинности учетной записи Майкрософт. Документация по OAuth для учетной записи Майкрософт: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_o_auth_scopes	list[str] Области OAuth 2.0, которые будут запрошены в рамках проверки подлинности учетной записи Майкрософт. Это необязательный параметр. Если значение не указано, в качестве область по умолчанию используется wl.basic. Документация по областям и разрешениям учетной записи Майкрософт: https://msdn.microsoft.com/en-us/library/dn631845.aspx.