SiteAuthSettings Class

Configuration settings for the Azure App Service Authentication / Authorization feature.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

azure.mgmt.web.v2021_01_15.models._models_py3.ProxyOnlyResource

SiteAuthSettings

Constructor

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, config_version: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
kind	str Kind of resource.
enabled	bool <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
runtime_version	str The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
unauthenticated_client_action	str or UnauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. Known values are: "RedirectToLoginPage" and "AllowAnonymous".
token_store_enabled	bool <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>. The default is <code>false</code>.
allowed_external_redirect_urls	list[str] External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
default_provider	str or BuiltInAuthenticationProvider The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". Known values are: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter", and "Github".
token_refresh_extension_hours	float The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
client_id	str The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_setting_name	str The app setting name that contains the client secret of the relying party application.
client_secret_certificate_thumbprint	str An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
issuer	str The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
allowed_audiences	list[str] Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the <code>ClientID</code> value is always considered an allowed audience, regardless of this setting.
additional_login_params	list[str] Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
aad_claims_authorization	str Gets a JSON string containing the Azure AD Acl settings.
google_client_id	str The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret	str The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret_setting_name	str The app setting name that contains the client secret associated with the Google web application.
google_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret_setting_name	str The app setting name that contains the app secret used for Facebook Login.
facebook_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login.
git_hub_client_id	str The Client Id of the GitHub app used for login. This setting is required for enabling Github login.
git_hub_client_secret	str The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
git_hub_client_secret_setting_name	str The app setting name that contains the client secret of the Github app used for GitHub Login.
git_hub_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional.
twitter_consumer_key	str The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret_setting_name	str The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
microsoft_account_client_id	str The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret_setting_name	str The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
microsoft_account_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx.
is_auth_from_file	str "true" if the auth config settings should be read from a file, "false" otherwise.
auth_file_path	str The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
config_version	str The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.

Variables

Name	Description
id	str Resource Id.
name	str Resource Name.
kind	str Kind of resource.
type	str Resource type.
enabled	bool <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
runtime_version	str The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
unauthenticated_client_action	str or UnauthenticatedClientAction The action to take when an unauthenticated client attempts to access the app. Known values are: "RedirectToLoginPage" and "AllowAnonymous".
token_store_enabled	bool <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>. The default is <code>false</code>.
allowed_external_redirect_urls	list[str] External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.
default_provider	str or BuiltInAuthenticationProvider The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". Known values are: "AzureActiveDirectory", "Facebook", "Google", "MicrosoftAccount", "Twitter", and "Github".
token_refresh_extension_hours	float The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.
client_id	str The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret	str The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html.
client_secret_setting_name	str The app setting name that contains the client secret of the relying party application.
client_secret_certificate_thumbprint	str An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.
issuer	str The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html.
validate_issuer	bool Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
allowed_audiences	list[str] Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the <code>ClientID</code> value is always considered an allowed audience, regardless of this setting.
additional_login_params	list[str] Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
aad_claims_authorization	str Gets a JSON string containing the Azure AD Acl settings.
google_client_id	str The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret	str The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/.
google_client_secret_setting_name	str The app setting name that contains the client secret associated with the Google web application.
google_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/.
facebook_app_id	str The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret	str The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login.
facebook_app_secret_setting_name	str The app setting name that contains the app secret used for Facebook Login.
facebook_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login.
git_hub_client_id	str The Client Id of the GitHub app used for login. This setting is required for enabling Github login.
git_hub_client_secret	str The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
git_hub_client_secret_setting_name	str The app setting name that contains the client secret of the Github app used for GitHub Login.
git_hub_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional.
twitter_consumer_key	str The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret	str The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in.
twitter_consumer_secret_setting_name	str The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
microsoft_account_client_id	str The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret	str The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm.
microsoft_account_client_secret_setting_name	str The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
microsoft_account_o_auth_scopes	list[str] The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx.
is_auth_from_file	str "true" if the auth config settings should be read from a file, "false" otherwise.
auth_file_path	str The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
config_version	str The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization.