你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

SiteAuthSettings 类

Azure 应用服务身份验证/授权功能的配置设置。

变量仅由服务器填充,发送请求时将被忽略。

继承
azure.mgmt.web.v2020_06_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_setting_name: 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, aad_claims_authorization: str | None = None, google_client_id: str | None = None, google_client_secret: str | None = None, google_client_secret_setting_name: str | None = None, google_o_auth_scopes: List[str] | None = None, facebook_app_id: str | None = None, facebook_app_secret: str | None = None, facebook_app_secret_setting_name: str | None = None, facebook_o_auth_scopes: List[str] | None = None, git_hub_client_id: str | None = None, git_hub_client_secret: str | None = None, git_hub_client_secret_setting_name: str | None = None, git_hub_o_auth_scopes: List[str] | None = None, twitter_consumer_key: str | None = None, twitter_consumer_secret: str | None = None, twitter_consumer_secret_setting_name: str | None = None, microsoft_account_client_id: str | None = None, microsoft_account_client_secret: str | None = None, microsoft_account_client_secret_setting_name: str | None = None, microsoft_account_o_auth_scopes: List[str] | None = None, is_auth_from_file: str | None = None, auth_file_path: str | None = None, **kwargs: Any)

仅限关键字的参数

名称 说明
kind
str

资源类型。

enabled

<code>true</code> 如果为当前应用启用了身份验证/授权功能,则为 ;否则为 <code>false</code>

runtime_version
str

当前应用使用的身份验证/授权功能的 RuntimeVersion。 此值中的设置可以控制身份验证/授权模块中某些功能的行为。

unauthenticated_client_action

未经身份验证的客户端尝试访问应用时要执行的操作。 已知值为:“RedirectToLoginPage”和“AllowAnonymous”。

token_store_enabled

<code>true</code> 以持久存储登录流期间获取的平台特定安全令牌;否则为 <code>false</code>

默认为 <code>false</code>

allowed_external_redirect_urls

登录或注销应用时可重定向到的外部 URL。 请注意,将忽略 URL 的查询字符串部分。 这是通常只有 Windows 应用商店应用程序后端才需要的高级设置。 请注意,始终隐式允许当前域中的 URL。

default_provider

配置多个提供程序时使用的默认身份验证提供程序。 仅当配置了多个提供程序并且未经身份验证的客户端操作设置为“RedirectToLoginPage”时,才需要此设置。 已知值为:“AzureActiveDirectory”、“Facebook”、“Google”、“MicrosoftAccount”、“Twitter”和“Github”。

token_refresh_extension_hours

会话令牌过期后可用于调用令牌刷新 API 的小时数。 默认值为 72 小时。

client_id
str

此信赖方应用程序的客户端 ID,称为client_id。 若要使用 Azure Active Directory 或其他第三方 OpenID Connect 提供程序启用 OpenID 连接身份验证,则需要此设置。 有关 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_setting_name
str

包含信赖方应用程序的客户端密码的应用设置名称。

client_secret_certificate_thumbprint
str

客户端密码的替代方法,即用于签名的证书的指纹。 此属性充当客户端密码的替代项。 这也是可选的。

issuer
str

OpenID Connect 颁发者 URI,表示为此应用程序颁发访问令牌的实体。 使用 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

获取一个值,该值指示颁发者是否应为有效的 HTTPS URL 并对其进行验证。

allowed_audiences

允许在验证 Azure Active Directory 颁发的 JWT 时考虑的受众值。 请注意,无论此设置如何, <code>ClientID</code> 该值始终被视为允许的受众。

additional_login_params

用户登录时要发送到 OpenID Connect 授权终结点的登录参数。 每个参数必须采用“key=value”格式。

aad_claims_authorization
str

获取包含 Azure AD Acl 设置的 JSON 字符串。

google_client_id
str

Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 Google 登录需要此设置。 Google Sign-In 文档: https://developers.google.com/identity/sign-in/web/

google_client_secret
str

与 Google Web 应用程序关联的客户端密码。 启用 Google 登录需要此设置。 Google Sign-In 文档: https://developers.google.com/identity/sign-in/web/

google_client_secret_setting_name
str

包含与 Google Web 应用程序关联的客户端密码的应用设置名称。

google_o_auth_scopes

将在 Google Sign-In 身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定,“openid”、“profile”和“email”将用作默认范围。 Google Sign-In 文档: https://developers.google.com/identity/sign-in/web/

facebook_app_id
str

用于登录的 Facebook 应用的应用 ID。 启用 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_app_secret_setting_name
str

包含用于 Facebook 登录的应用机密的应用设置名称。

facebook_o_auth_scopes

将在 Facebook 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 Facebook 登录文档: https://developers.facebook.com/docs/facebook-login

git_hub_client_id
str

用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置。

git_hub_client_secret
str

用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。

git_hub_client_secret_setting_name
str

应用设置名称,其中包含用于 GitHub 登录的 Github 应用的客户端密码。

git_hub_o_auth_scopes

将在 GitHub 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。

twitter_consumer_key
str

用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者密钥。 此设置是启用 Twitter 登录所必需的。 Twitter Sign-In 文档: https://dev.twitter.com/web/sign-in

twitter_consumer_secret
str

用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。 此设置是启用 Twitter 登录所必需的。 Twitter Sign-In 文档: https://dev.twitter.com/web/sign-in

twitter_consumer_secret_setting_name
str

应用设置名称,其中包含用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。

microsoft_account_client_id
str

为用于身份验证的应用创建的 OAuth 2.0 客户端 ID。 此设置是启用 Microsoft 帐户身份验证所必需的。 Microsoft 帐户 OAuth 文档: https://dev.onedrive.com/auth/msa_oauth.htm

microsoft_account_client_secret
str

为用于身份验证的应用创建的 OAuth 2.0 客户端密码。 此设置是启用 Microsoft 帐户身份验证所必需的。 Microsoft 帐户 OAuth 文档: https://dev.onedrive.com/auth/msa_oauth.htm

microsoft_account_client_secret_setting_name
str

应用设置名称,其中包含为用于身份验证的应用创建的 OAuth 2.0 客户端机密。

microsoft_account_o_auth_scopes

将在 Microsoft 帐户身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定,则使用“wl.basic”作为默认范围。 Microsoft 帐户范围和权限文档: https://msdn.microsoft.com/en-us/library/dn631845.aspx

is_auth_from_file
str

如果应从文件中读取身份验证配置设置,则为“true”;否则为“false”。

auth_file_path
str

包含身份验证设置的配置文件的路径。 如果路径是相对路径,则 base 将作为站点的根目录。

变量

名称 说明
id
str

资源 ID。

name
str

资源名称。

kind
str

资源类型。

type
str

资源类型。

enabled

<code>true</code> 如果为当前应用启用了身份验证/授权功能,则为 ;否则为 <code>false</code>

runtime_version
str

当前应用使用的身份验证/授权功能的 RuntimeVersion。 此值中的设置可以控制身份验证/授权模块中某些功能的行为。

unauthenticated_client_action

未经身份验证的客户端尝试访问应用时要执行的操作。 已知值为:“RedirectToLoginPage”和“AllowAnonymous”。

token_store_enabled

<code>true</code> 用于持久存储登录流期间获取的平台特定安全令牌;否则为 <code>false</code>

默认为 <code>false</code>

allowed_external_redirect_urls

可在登录或注销应用时重定向到的外部 URL。 请注意,将忽略 URL 的查询字符串部分。 这是一种高级设置,通常只有 Windows 应用商店应用程序后端才需要。 请注意,始终隐式允许当前域中的 URL。

default_provider

配置多个提供程序时要使用的默认身份验证提供程序。 仅当配置了多个提供程序并且未经身份验证的客户端操作设置为“RedirectToLoginPage”时,才需要此设置。 已知值为:“AzureActiveDirectory”、“Facebook”、“Google”、“MicrosoftAccount”、“Twitter”和“Github”。

token_refresh_extension_hours

会话令牌过期后的小时数,会话令牌可用于调用令牌刷新 API。 默认值为 72 小时。

client_id
str

此信赖方应用程序的客户端 ID,称为 client_id。 此设置是使用 Azure Active Directory 或其他第三方 OpenID Connect 提供程序启用 OpenID 连接身份验证所必需的。 有关 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_setting_name
str

包含信赖方应用程序的客户端密码的应用设置名称。

client_secret_certificate_thumbprint
str

客户端密码的替代方法,即用于签名的证书的指纹。 此属性充当客户端密码的替换。 这也是可选的。

issuer
str

OpenID Connect 颁发者 URI,表示颁发此应用程序的访问令牌的实体。 使用 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

获取一个值,该值指示颁发者是否应是有效的 HTTPS URL 并对其进行验证。

allowed_audiences

允许在验证 Azure Active Directory 颁发的 JWT 时考虑的受众值。 请注意,无论此设置如何, <code>ClientID</code> 值始终被视为允许的受众。

additional_login_params

用户登录时要发送到 OpenID Connect 授权终结点的登录参数。 每个参数必须采用“key=value”格式。

aad_claims_authorization
str

获取包含 Azure AD Acl 设置的 JSON 字符串。

google_client_id
str

Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 Google 登录需要此设置。 Google Sign-In 文档: https://developers.google.com/identity/sign-in/web/

google_client_secret
str

与 Google Web 应用程序关联的客户端密码。 启用 Google 登录需要此设置。 Google Sign-In 文档: https://developers.google.com/identity/sign-in/web/

google_client_secret_setting_name
str

包含与 Google Web 应用程序关联的客户端密码的应用设置名称。

google_o_auth_scopes

将在 Google Sign-In 身份验证过程中请求的 OAuth 2.0 作用域。 此设置是可选的。 如果未指定,“openid”、“profile”和“email”将用作默认范围。 Google Sign-In 文档: https://developers.google.com/identity/sign-in/web/

facebook_app_id
str

用于登录的 Facebook 应用的应用 ID。 启用 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_app_secret_setting_name
str

包含用于 Facebook 登录的应用机密的应用设置名称。

facebook_o_auth_scopes

将在 Facebook 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 Facebook 登录文档: https://developers.facebook.com/docs/facebook-login

git_hub_client_id
str

用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置。

git_hub_client_secret
str

用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。

git_hub_client_secret_setting_name
str

应用设置名称,其中包含用于 GitHub 登录的 Github 应用的客户端密码。

git_hub_o_auth_scopes

将在 GitHub 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。

twitter_consumer_key
str

用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者密钥。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档: https://dev.twitter.com/web/sign-in

twitter_consumer_secret
str

用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档: https://dev.twitter.com/web/sign-in

twitter_consumer_secret_setting_name
str

包含用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密的应用设置名称。

microsoft_account_client_id
str

为用于身份验证的应用创建的 OAuth 2.0 客户端 ID。 启用 Microsoft 帐户身份验证需要此设置。 Microsoft 帐户 OAuth 文档: https://dev.onedrive.com/auth/msa_oauth.htm

microsoft_account_client_secret
str

为用于身份验证的应用创建的 OAuth 2.0 客户端密码。 启用 Microsoft 帐户身份验证需要此设置。 Microsoft 帐户 OAuth 文档: https://dev.onedrive.com/auth/msa_oauth.htm

microsoft_account_client_secret_setting_name
str

应用设置名称,其中包含为用于身份验证的应用创建的 OAuth 2.0 客户端密码。

microsoft_account_o_auth_scopes

将在 Microsoft 帐户身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定,则使用“wl.basic”作为默认范围。 Microsoft 帐户范围和权限文档: https://msdn.microsoft.com/en-us/library/dn631845.aspx

is_auth_from_file
str

如果应从文件读取身份验证配置设置,则为“true”,否则为“false”。

auth_file_path
str

包含身份验证设置的配置文件的路径。 如果路径是相对路径,则 base 将用于站点的根目录。