SiteAuthSettings interface

Package:

@azure/arm-appservice

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

Extends

ProxyOnlyResource

Properties

aadClaimsAuthorization	Gets a JSON string containing the Azure AD Acl settings.
additionalLoginParams	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	Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.
allowedExternalRedirectUrls	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.
authFilePath	The path of the config file containing auth settings. If the path is relative, base will the site's root directory.
clientId	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	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
clientSecretCertificateThumbprint	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.
clientSecretSettingName	The app setting name that contains the client secret of the relying party application.
configVersion	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.
defaultProvider	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".
enabled	true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
facebookAppId	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	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	The app setting name that contains the app secret used for Facebook Login.
facebookOAuthScopes	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	The Client Id of the GitHub app used for login. This setting is required for enabling Github login
gitHubClientSecret	The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.
gitHubClientSecretSettingName	The app setting name that contains the client secret of the Github app used for GitHub Login.
gitHubOAuthScopes	The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional
googleClientId	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	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	The app setting name that contains the client secret associated with the Google web application.
googleOAuthScopes	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/
isAuthFromFile	"true" if the auth config settings should be read from a file, "false" otherwise
issuer	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
microsoftAccountClientId	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	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	The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
microsoftAccountOAuthScopes	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
runtimeVersion	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	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	true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.
twitterConsumerKey	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	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	The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
unauthenticatedClientAction	The action to take when an unauthenticated client attempts to access the app.
validateIssuer	Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.

Inherited Properties

id	Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind	Kind of resource.
name	Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
type	Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

aadClaimsAuthorization

Gets a JSON string containing the Azure AD Acl settings.

aadClaimsAuthorization?: string

Property Value

string

additionalLoginParams

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

additionalLoginParams?: string[]

Property Value

string[]

allowedAudiences

Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.

allowedAudiences?: string[]

Property Value

string[]

allowedExternalRedirectUrls

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.

allowedExternalRedirectUrls?: string[]

Property Value

string[]

authFilePath

The path of the config file containing auth settings. If the path is relative, base will the site's root directory.

authFilePath?: string

Property Value

string

clientId

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

clientId?: string

Property Value

string

clientSecret

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

clientSecret?: string

Property Value

string

clientSecretCertificateThumbprint

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.

clientSecretCertificateThumbprint?: string

Property Value

string

clientSecretSettingName

The app setting name that contains the client secret of the relying party application.

clientSecretSettingName?: string

Property Value

string

configVersion

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.

configVersion?: string

Property Value

string

defaultProvider

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".

defaultProvider?: BuiltInAuthenticationProvider

Property Value

BuiltInAuthenticationProvider

enabled

true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.

enabled?: boolean

Property Value

boolean

facebookAppId

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

facebookAppId?: string

Property Value

string

facebookAppSecret

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

facebookAppSecret?: string

Property Value

string

facebookAppSecretSettingName

The app setting name that contains the app secret used for Facebook Login.

facebookAppSecretSettingName?: string

Property Value

string

facebookOAuthScopes

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

facebookOAuthScopes?: string[]

Property Value

string[]

gitHubClientId

The Client Id of the GitHub app used for login. This setting is required for enabling Github login

gitHubClientId?: string

Property Value

string

gitHubClientSecret

The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login.

gitHubClientSecret?: string

Property Value

string

gitHubClientSecretSettingName

The app setting name that contains the client secret of the Github app used for GitHub Login.

gitHubClientSecretSettingName?: string

Property Value

string

gitHubOAuthScopes

The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional

gitHubOAuthScopes?: string[]

Property Value

string[]

googleClientId

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/

googleClientId?: string

Property Value

string

googleClientSecret

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/

googleClientSecret?: string

Property Value

string

googleClientSecretSettingName

The app setting name that contains the client secret associated with the Google web application.

googleClientSecretSettingName?: string

Property Value

string

googleOAuthScopes

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/

googleOAuthScopes?: string[]

Property Value

string[]

isAuthFromFile

"true" if the auth config settings should be read from a file, "false" otherwise

isAuthFromFile?: string

Property Value

string

issuer

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

issuer?: string

Property Value

string

microsoftAccountClientId

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

microsoftAccountClientId?: string

Property Value

string

microsoftAccountClientSecret

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

microsoftAccountClientSecret?: string

Property Value

string

microsoftAccountClientSecretSettingName

The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.

microsoftAccountClientSecretSettingName?: string

Property Value

string

microsoftAccountOAuthScopes

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

microsoftAccountOAuthScopes?: string[]

Property Value

string[]

runtimeVersion

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.

runtimeVersion?: string

Property Value

string

tokenRefreshExtensionHours

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.

tokenRefreshExtensionHours?: number

Property Value

number

tokenStoreEnabled

true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.

tokenStoreEnabled?: boolean

Property Value

boolean

twitterConsumerKey

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

twitterConsumerKey?: string

Property Value

string

twitterConsumerSecret

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

twitterConsumerSecret?: string

Property Value

string

twitterConsumerSecretSettingName

The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.

twitterConsumerSecretSettingName?: string

Property Value

string

unauthenticatedClientAction

The action to take when an unauthenticated client attempts to access the app.

unauthenticatedClientAction?: UnauthenticatedClientAction

Property Value

UnauthenticatedClientAction

validateIssuer

Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.

validateIssuer?: boolean

Property Value

boolean

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyOnlyResource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From ProxyOnlyResource.kind

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyOnlyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyOnlyResource.type