SiteAuthSettingsInner Class

Definition

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

[Microsoft.Rest.Serialization.JsonTransformation]
public class SiteAuthSettingsInner : Microsoft.Azure.Management.AppService.Fluent.Models.ProxyOnlyResource
type SiteAuthSettingsInner = class
    inherit ProxyOnlyResource
Public Class SiteAuthSettingsInner
Inherits ProxyOnlyResource
Inheritance
SiteAuthSettingsInner
Attributes
Microsoft.Rest.Serialization.JsonTransformationAttribute

Constructors

SiteAuthSettingsInner()

Initializes a new instance of the SiteAuthSettingsInner class.

SiteAuthSettingsInner(String, String, String, String, Nullable<Boolean>, String, Nullable<UnauthenticatedClientAction>, Nullable<Boolean>, IList<String>, Nullable<BuiltInAuthenticationProvider>, Nullable<Double>, String, String, String, IList<String>, IList<String>, String, String, IList<String>, String, String, IList<String>, String, String, String, String, IList<String>)

Properties

AdditionalLoginParams

Gets or sets login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

AllowedAudiences

Gets or sets allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the &lt;code&gt;ClientID&lt;/code&gt; value is always considered an allowed audience, regardless of this setting.

AllowedExternalRedirectUrls

Gets or sets 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.

ClientId

Gets or sets 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

Gets or sets 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

DefaultProvider

Gets or sets 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'

Enabled

Gets or sets &lt;code&gt;true&lt;/code&gt; if the Authentication / Authorization feature is enabled for the current app; otherwise, &lt;code&gt;false&lt;/code&gt;.

FacebookAppId

Gets or sets 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

Gets or sets 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

FacebookOAuthScopes

Gets or sets 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

GoogleClientId

Gets or sets 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

Gets or sets 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/

GoogleOAuthScopes

Gets or sets 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/

Id (Inherited from ProxyOnlyResource)
Issuer

Gets or sets 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

Kind (Inherited from ProxyOnlyResource)
MicrosoftAccountClientId

Gets or sets 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

Gets or sets 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

MicrosoftAccountOAuthScopes

Gets or sets 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

Name (Inherited from ProxyOnlyResource)
RuntimeVersion

Gets or sets 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.

TokenRefreshExtensionHours

Gets or sets 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.

TokenStoreEnabled

Gets or sets &lt;code&gt;true&lt;/code&gt; to durably store platform-specific security tokens that are obtained during login flows; otherwise, &lt;code&gt;false&lt;/code&gt;. The default is &lt;code&gt;false&lt;/code&gt;.

TwitterConsumerKey

Gets or sets 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

Gets or sets 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

Type (Inherited from ProxyOnlyResource)
UnauthenticatedClientAction

Gets or sets the action to take when an unauthenticated client attempts to access the app. Possible values include: 'RedirectToLoginPage', 'AllowAnonymous'

Applies to