SiteAuthSettings Constructors
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
SiteAuthSettings()
Initializes a new instance of the SiteAuthSettings class.
public SiteAuthSettings ();Public Sub New ()Applies to
SiteAuthSettings(String, String, String, String, Nullable<Boolean>, String, Nullable<UnauthenticatedClientAction>, Nullable<Boolean>, IList<String>, Nullable<BuiltInAuthenticationProvider>, Nullable<Double>, String, String, String, String, String, Nullable<Boolean>, IList<String>, IList<String>, String, String, String, String, IList<String>, String, String, String, IList<String>, String, String, String, IList<String>, String, String, String, String, String, String, IList<String>, String, String, String)
Initializes a new instance of the SiteAuthSettings class.
public SiteAuthSettings (string id = default, string name = default, string kind = default, string type = default, bool? enabled = default, string runtimeVersion = default, Microsoft.Azure.Management.WebSites.Models.UnauthenticatedClientAction? unauthenticatedClientAction = default, bool? tokenStoreEnabled = default, System.Collections.Generic.IList<string> allowedExternalRedirectUrls = default, Microsoft.Azure.Management.WebSites.Models.BuiltInAuthenticationProvider? defaultProvider = default, double? tokenRefreshExtensionHours = default, string clientId = default, string clientSecret = default, string clientSecretSettingName = default, string clientSecretCertificateThumbprint = default, string issuer = default, bool? validateIssuer = default, System.Collections.Generic.IList<string> allowedAudiences = default, System.Collections.Generic.IList<string> additionalLoginParams = default, string aadClaimsAuthorization = default, string googleClientId = default, string googleClientSecret = default, string googleClientSecretSettingName = default, System.Collections.Generic.IList<string> googleOAuthScopes = default, string facebookAppId = default, string facebookAppSecret = default, string facebookAppSecretSettingName = default, System.Collections.Generic.IList<string> facebookOAuthScopes = default, string gitHubClientId = default, string gitHubClientSecret = default, string gitHubClientSecretSettingName = default, System.Collections.Generic.IList<string> gitHubOAuthScopes = default, string twitterConsumerKey = default, string twitterConsumerSecret = default, string twitterConsumerSecretSettingName = default, string microsoftAccountClientId = default, string microsoftAccountClientSecret = default, string microsoftAccountClientSecretSettingName = default, System.Collections.Generic.IList<string> microsoftAccountOAuthScopes = default, string isAuthFromFile = default, string authFilePath = default, string configVersion = default);new Microsoft.Azure.Management.WebSites.Models.SiteAuthSettings : string * string * string * string * Nullable<bool> * string * Nullable<Microsoft.Azure.Management.WebSites.Models.UnauthenticatedClientAction> * Nullable<bool> * System.Collections.Generic.IList<string> * Nullable<Microsoft.Azure.Management.WebSites.Models.BuiltInAuthenticationProvider> * Nullable<double> * string * string * string * string * string * Nullable<bool> * System.Collections.Generic.IList<string> * System.Collections.Generic.IList<string> * string * string * string * string * System.Collections.Generic.IList<string> * string * string * string * System.Collections.Generic.IList<string> * string * string * string * System.Collections.Generic.IList<string> * string * string * string * string * string * string * System.Collections.Generic.IList<string> * string * string * string -> Microsoft.Azure.Management.WebSites.Models.SiteAuthSettingsPublic Sub New (Optional id As String = Nothing, Optional name As String = Nothing, Optional kind As String = Nothing, Optional type As String = Nothing, Optional enabled As Nullable(Of Boolean) = Nothing, Optional runtimeVersion As String = Nothing, Optional unauthenticatedClientAction As Nullable(Of UnauthenticatedClientAction) = Nothing, Optional tokenStoreEnabled As Nullable(Of Boolean) = Nothing, Optional allowedExternalRedirectUrls As IList(Of String) = Nothing, Optional defaultProvider As Nullable(Of BuiltInAuthenticationProvider) = Nothing, Optional tokenRefreshExtensionHours As Nullable(Of Double) = Nothing, Optional clientId As String = Nothing, Optional clientSecret As String = Nothing, Optional clientSecretSettingName As String = Nothing, Optional clientSecretCertificateThumbprint As String = Nothing, Optional issuer As String = Nothing, Optional validateIssuer As Nullable(Of Boolean) = Nothing, Optional allowedAudiences As IList(Of String) = Nothing, Optional additionalLoginParams As IList(Of String) = Nothing, Optional aadClaimsAuthorization As String = Nothing, Optional googleClientId As String = Nothing, Optional googleClientSecret As String = Nothing, Optional googleClientSecretSettingName As String = Nothing, Optional googleOAuthScopes As IList(Of String) = Nothing, Optional facebookAppId As String = Nothing, Optional facebookAppSecret As String = Nothing, Optional facebookAppSecretSettingName As String = Nothing, Optional facebookOAuthScopes As IList(Of String) = Nothing, Optional gitHubClientId As String = Nothing, Optional gitHubClientSecret As String = Nothing, Optional gitHubClientSecretSettingName As String = Nothing, Optional gitHubOAuthScopes As IList(Of String) = Nothing, Optional twitterConsumerKey As String = Nothing, Optional twitterConsumerSecret As String = Nothing, Optional twitterConsumerSecretSettingName As String = Nothing, Optional microsoftAccountClientId As String = Nothing, Optional microsoftAccountClientSecret As String = Nothing, Optional microsoftAccountClientSecretSettingName As String = Nothing, Optional microsoftAccountOAuthScopes As IList(Of String) = Nothing, Optional isAuthFromFile As String = Nothing, Optional authFilePath As String = Nothing, Optional configVersion As String = Nothing)Parameters
- id
- String
Resource Id.
- name
- String
Resource Name.
- kind
- String
Kind of resource.
- type
- String
Resource type.
<code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
- runtimeVersion
- String
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.
- unauthenticatedClientAction
- Nullable<UnauthenticatedClientAction>
The action to take when an unauthenticated client attempts to access the app. Possible values include: 'RedirectToLoginPage', 'AllowAnonymous'
<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>.
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.
- defaultProvider
- Nullable<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". Possible values include: 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter', 'Github'
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.
- clientId
- String
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
- clientSecret
- String
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
- clientSecretSettingName
- String
The app setting name that contains the client secret of the relying party application.
- clientSecretCertificateThumbprint
- String
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
- String
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
Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
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.
Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".
- aadClaimsAuthorization
- String
Gets a JSON string containing the Azure AD Acl settings.
- googleClientId
- String
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/
- googleClientSecret
- String
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/
- googleClientSecretSettingName
- String
The app setting name that contains the client secret associated with the Google web application.
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/
- facebookAppId
- String
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
- facebookAppSecret
- String
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
- facebookAppSecretSettingName
- String
The app setting name that contains the app secret used for Facebook Login.
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
- gitHubClientId
- String
The Client Id of the GitHub app used for login. This setting is required for enabling Github login
- gitHubClientSecret
- String
The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
- gitHubClientSecretSettingName
- String
The app setting name that contains the client secret of the Github app used for GitHub Login.
The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
- twitterConsumerKey
- String
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
- twitterConsumerSecret
- String
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
- twitterConsumerSecretSettingName
- String
The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
- microsoftAccountClientId
- String
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
- microsoftAccountClientSecret
- String
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
- microsoftAccountClientSecretSettingName
- String
The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
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
- isAuthFromFile
- String
"true" if the auth config settings should be read from a file, "false" otherwise
- authFilePath
- String
The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
- configVersion
- String
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.
