SiteAuthSettingsInner Class

Package:

com.azure.resourcemanager.appservice.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-appservice:2.45.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.appservice.models.ProxyOnlyResource
    • • com.azure.resourcemanager.appservice.fluent.models.SiteAuthSettingsInner

public final class SiteAuthSettingsInner
extends ProxyOnlyResource

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

Constructor Summary

Constructor	Description
SiteAuthSettingsInner()	Creates an instance of SiteAuthSettingsInner class.

Method Summary

Modifier and Type	Method and Description
String	aadClaimsAuthorization() Get the aadClaimsAuthorization property: Gets a JSON string containing the Azure AD Acl settings.
List<String>	additionalLoginParams() Get the additionalLoginParams property: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in.
List<String>	allowedAudiences() Get the allowedAudiences property: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory.
List<String>	allowedExternalRedirectUrls() Get the allowedExternalRedirectUrls property: External URLs that can be redirected to as part of logging in or logging out of the app.
String	authFilePath() Get the authFilePath property: The path of the config file containing auth settings.
String	clientId() Get the clientId property: The Client ID of this relying party application, known as the client_id.
String	clientSecret() Get the clientSecret property: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
String	clientSecretCertificateThumbprint() Get the clientSecretCertificateThumbprint property: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes.
String	clientSecretSettingName() Get the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.
String	configVersion() Get the configVersion property: The ConfigVersion of the Authentication / Authorization feature in use for the current app.
BuiltInAuthenticationProvider	defaultProvider() Get the defaultProvider property: The default authentication provider to use when multiple providers are configured.
Boolean	enabled() Get the enabled property: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
String	facebookAppId() Get the facebookAppId property: The App ID of the Facebook app used for login.
String	facebookAppSecret() Get the facebookAppSecret property: The App Secret of the Facebook app used for Facebook Login.
String	facebookAppSecretSettingName() Get the facebookAppSecretSettingName property: The app setting name that contains the app secret used for Facebook Login.
List<String>	facebookOAuthScopes() Get the facebookOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
static SiteAuthSettingsInner	fromJson(JsonReader jsonReader) Reads an instance of SiteAuthSettingsInner from the JsonReader.
String	gitHubClientId() Get the gitHubClientId property: The Client Id of the GitHub app used for login.
String	gitHubClientSecret() Get the gitHubClientSecret property: The Client Secret of the GitHub app used for Github Login.
String	gitHubClientSecretSettingName() Get the gitHubClientSecretSettingName property: The app setting name that contains the client secret of the Github app used for GitHub Login.
List<String>	gitHubOAuthScopes() Get the gitHubOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
String	googleClientId() Get the googleClientId property: The OpenID Connect Client ID for the Google web application.
String	googleClientSecret() Get the googleClientSecret property: The client secret associated with the Google web application.
String	googleClientSecretSettingName() Get the googleClientSecretSettingName property: The app setting name that contains the client secret associated with the Google web application.
List<String>	googleOAuthScopes() Get the googleOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	isAuthFromFile() Get the isAuthFromFile property: "true" if the auth config settings should be read from a file, "false" otherwise.
String	issuer() Get the issuer property: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
String	microsoftAccountClientId() Get the microsoftAccountClientId property: The OAuth 2.0 client ID that was created for the app used for authentication.
String	microsoftAccountClientSecret() Get the microsoftAccountClientSecret property: The OAuth 2.0 client secret that was created for the app used for authentication.
String	microsoftAccountClientSecretSettingName() Get the microsoftAccountClientSecretSettingName property: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
List<String>	microsoftAccountOAuthScopes() Get the microsoftAccountOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
String	name() Get the name property: The name of the resource.
String	runtimeVersion() Get the runtimeVersion property: The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
JsonWriter	toJson(JsonWriter jsonWriter)
Double	tokenRefreshExtensionHours() Get the tokenRefreshExtensionHours property: The number of hours after session token expiration that a session token can be used to call the token refresh API.
Boolean	tokenStoreEnabled() Get the tokenStoreEnabled property: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.
String	twitterConsumerKey() Get the twitterConsumerKey property: The OAuth 1.0a consumer key of the Twitter application used for sign-in.
String	twitterConsumerSecret() Get the twitterConsumerSecret property: The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
String	twitterConsumerSecretSettingName() Get the twitterConsumerSecretSettingName property: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
String	type() Get the type property: The type of the resource.
UnauthenticatedClientAction	unauthenticatedClientAction() Get the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.
void	validate() Validates the instance.
Boolean	validateIssuer() Get the validateIssuer property: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
SiteAuthSettingsInner	withAadClaimsAuthorization(String aadClaimsAuthorization) Set the aadClaimsAuthorization property: Gets a JSON string containing the Azure AD Acl settings.
SiteAuthSettingsInner	withAdditionalLoginParams(List<String> additionalLoginParams) Set the additionalLoginParams property: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in.
SiteAuthSettingsInner	withAllowedAudiences(List<String> allowedAudiences) Set the allowedAudiences property: Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory.
SiteAuthSettingsInner	withAllowedExternalRedirectUrls(List<String> allowedExternalRedirectUrls) Set the allowedExternalRedirectUrls property: External URLs that can be redirected to as part of logging in or logging out of the app.
SiteAuthSettingsInner	withAuthFilePath(String authFilePath) Set the authFilePath property: The path of the config file containing auth settings.
SiteAuthSettingsInner	withClientId(String clientId) Set the clientId property: The Client ID of this relying party application, known as the client_id.
SiteAuthSettingsInner	withClientSecret(String clientSecret) Set the clientSecret property: The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).
SiteAuthSettingsInner	withClientSecretCertificateThumbprint(String clientSecretCertificateThumbprint) Set the clientSecretCertificateThumbprint property: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes.
SiteAuthSettingsInner	withClientSecretSettingName(String clientSecretSettingName) Set the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.
SiteAuthSettingsInner	withConfigVersion(String configVersion) Set the configVersion property: The ConfigVersion of the Authentication / Authorization feature in use for the current app.
SiteAuthSettingsInner	withDefaultProvider(BuiltInAuthenticationProvider defaultProvider) Set the defaultProvider property: The default authentication provider to use when multiple providers are configured.
SiteAuthSettingsInner	withEnabled(Boolean enabled) Set the enabled property: true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.
SiteAuthSettingsInner	withFacebookAppId(String facebookAppId) Set the facebookAppId property: The App ID of the Facebook app used for login.
SiteAuthSettingsInner	withFacebookAppSecret(String facebookAppSecret) Set the facebookAppSecret property: The App Secret of the Facebook app used for Facebook Login.
SiteAuthSettingsInner	withFacebookAppSecretSettingName(String facebookAppSecretSettingName) Set the facebookAppSecretSettingName property: The app setting name that contains the app secret used for Facebook Login.
SiteAuthSettingsInner	withFacebookOAuthScopes(List<String> facebookOAuthScopes) Set the facebookOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
SiteAuthSettingsInner	withGitHubClientId(String gitHubClientId) Set the gitHubClientId property: The Client Id of the GitHub app used for login.
SiteAuthSettingsInner	withGitHubClientSecret(String gitHubClientSecret) Set the gitHubClientSecret property: The Client Secret of the GitHub app used for Github Login.
SiteAuthSettingsInner	withGitHubClientSecretSettingName(String gitHubClientSecretSettingName) Set the gitHubClientSecretSettingName property: The app setting name that contains the client secret of the Github app used for GitHub Login.
SiteAuthSettingsInner	withGitHubOAuthScopes(List<String> gitHubOAuthScopes) Set the gitHubOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
SiteAuthSettingsInner	withGoogleClientId(String googleClientId) Set the googleClientId property: The OpenID Connect Client ID for the Google web application.
SiteAuthSettingsInner	withGoogleClientSecret(String googleClientSecret) Set the googleClientSecret property: The client secret associated with the Google web application.
SiteAuthSettingsInner	withGoogleClientSecretSettingName(String googleClientSecretSettingName) Set the googleClientSecretSettingName property: The app setting name that contains the client secret associated with the Google web application.
SiteAuthSettingsInner	withGoogleOAuthScopes(List<String> googleOAuthScopes) Set the googleOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
SiteAuthSettingsInner	withIsAuthFromFile(String isAuthFromFile) Set the isAuthFromFile property: "true" if the auth config settings should be read from a file, "false" otherwise.
SiteAuthSettingsInner	withIssuer(String issuer) Set the issuer property: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
SiteAuthSettingsInner	withKind(String kind) Set the kind property: Kind of resource.
SiteAuthSettingsInner	withMicrosoftAccountClientId(String microsoftAccountClientId) Set the microsoftAccountClientId property: The OAuth 2.0 client ID that was created for the app used for authentication.
SiteAuthSettingsInner	withMicrosoftAccountClientSecret(String microsoftAccountClientSecret) Set the microsoftAccountClientSecret property: The OAuth 2.0 client secret that was created for the app used for authentication.
SiteAuthSettingsInner	withMicrosoftAccountClientSecretSettingName(String microsoftAccountClientSecretSettingName) Set the microsoftAccountClientSecretSettingName property: The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication.
SiteAuthSettingsInner	withMicrosoftAccountOAuthScopes(List<String> microsoftAccountOAuthScopes) Set the microsoftAccountOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
SiteAuthSettingsInner	withRuntimeVersion(String runtimeVersion) Set the runtimeVersion property: The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
SiteAuthSettingsInner	withTokenRefreshExtensionHours(Double tokenRefreshExtensionHours) Set the tokenRefreshExtensionHours property: The number of hours after session token expiration that a session token can be used to call the token refresh API.
SiteAuthSettingsInner	withTokenStoreEnabled(Boolean tokenStoreEnabled) Set the tokenStoreEnabled property: true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.
SiteAuthSettingsInner	withTwitterConsumerKey(String twitterConsumerKey) Set the twitterConsumerKey property: The OAuth 1.0a consumer key of the Twitter application used for sign-in.
SiteAuthSettingsInner	withTwitterConsumerSecret(String twitterConsumerSecret) Set the twitterConsumerSecret property: The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
SiteAuthSettingsInner	withTwitterConsumerSecretSettingName(String twitterConsumerSecretSettingName) Set the twitterConsumerSecretSettingName property: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in.
SiteAuthSettingsInner	withUnauthenticatedClientAction(UnauthenticatedClientAction unauthenticatedClientAction) Set the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.
SiteAuthSettingsInner	withValidateIssuer(Boolean validateIssuer) Set the validateIssuer property: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.

Methods inherited from ProxyOnlyResource

fromJson id kind name toJson type validate withKind

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SiteAuthSettingsInner

public SiteAuthSettingsInner()

Creates an instance of SiteAuthSettingsInner class.

Method Details

aadClaimsAuthorization

public String aadClaimsAuthorization()

Get the aadClaimsAuthorization property: Gets a JSON string containing the Azure AD Acl settings.

Returns:

the aadClaimsAuthorization value.

additionalLoginParams

public List additionalLoginParams()

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

Returns:

the additionalLoginParams value.

allowedAudiences

public List allowedAudiences()

Get the allowedAudiences property: 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.

Returns:

the allowedAudiences value.

allowedExternalRedirectUrls

public List allowedExternalRedirectUrls()

Get the allowedExternalRedirectUrls property: 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.

Returns:

the allowedExternalRedirectUrls value.

authFilePath

public String authFilePath()

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

Returns:

the authFilePath value.

clientId

public String clientId()

Get the clientId property: 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.

Returns:

the clientId value.

clientSecret

public String clientSecret()

Get the clientSecret property: 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.

Returns:

the clientSecret value.

clientSecretCertificateThumbprint

public String clientSecretCertificateThumbprint()

Get the clientSecretCertificateThumbprint property: 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.

Returns:

the clientSecretCertificateThumbprint value.

clientSecretSettingName

public String clientSecretSettingName()

Get the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.

Returns:

the clientSecretSettingName value.

configVersion

public String configVersion()

Get the configVersion property: 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.

Returns:

the configVersion value.

defaultProvider

public BuiltInAuthenticationProvider defaultProvider()

Get the defaultProvider property: 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".

Returns:

the defaultProvider value.

enabled

public Boolean enabled()

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

Returns:

the enabled value.

facebookAppId

public String facebookAppId()

Get the facebookAppId property: 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.

Returns:

the facebookAppId value.

facebookAppSecret

public String facebookAppSecret()

Get the facebookAppSecret property: 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.

Returns:

the facebookAppSecret value.

facebookAppSecretSettingName

public String facebookAppSecretSettingName()

Get the facebookAppSecretSettingName property: The app setting name that contains the app secret used for Facebook Login.

Returns:

the facebookAppSecretSettingName value.

facebookOAuthScopes

public List facebookOAuthScopes()

Get the facebookOAuthScopes property: 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.

Returns:

the facebookOAuthScopes value.

fromJson

public static SiteAuthSettingsInner fromJson(JsonReader jsonReader)

Reads an instance of SiteAuthSettingsInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SiteAuthSettingsInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

gitHubClientId

public String gitHubClientId()

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

Returns:

the gitHubClientId value.

gitHubClientSecret

public String gitHubClientSecret()

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

Returns:

the gitHubClientSecret value.

gitHubClientSecretSettingName

public String gitHubClientSecretSettingName()

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

Returns:

the gitHubClientSecretSettingName value.

gitHubOAuthScopes

public List gitHubOAuthScopes()

Get the gitHubOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional.

Returns:

the gitHubOAuthScopes value.

googleClientId

public String googleClientId()

Get the googleClientId property: 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/.

Returns:

the googleClientId value.

googleClientSecret

public String googleClientSecret()

Get the googleClientSecret property: 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/.

Returns:

the googleClientSecret value.

googleClientSecretSettingName

public String googleClientSecretSettingName()

Get the googleClientSecretSettingName property: The app setting name that contains the client secret associated with the Google web application.

Returns:

the googleClientSecretSettingName value.

googleOAuthScopes

public List googleOAuthScopes()

Get the googleOAuthScopes property: 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/.

Returns:

the googleOAuthScopes value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SiteAuthSettingsInner.id()

Returns:

the id value.

isAuthFromFile

public String isAuthFromFile()

Get the isAuthFromFile property: "true" if the auth config settings should be read from a file, "false" otherwise.

Returns:

the isAuthFromFile value.

issuer

public String issuer()

Get the issuer property: 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.

Returns:

the issuer value.

microsoftAccountClientId

public String microsoftAccountClientId()

Get the microsoftAccountClientId property: 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.

Returns:

the microsoftAccountClientId value.

microsoftAccountClientSecret

public String microsoftAccountClientSecret()

Get the microsoftAccountClientSecret property: 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.

Returns:

the microsoftAccountClientSecret value.

microsoftAccountClientSecretSettingName

public String microsoftAccountClientSecretSettingName()

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

Returns:

the microsoftAccountClientSecretSettingName value.

microsoftAccountOAuthScopes

public List microsoftAccountOAuthScopes()

Get the microsoftAccountOAuthScopes property: 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.

Returns:

the microsoftAccountOAuthScopes value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SiteAuthSettingsInner.name()

Returns:

the name value.

runtimeVersion

public String runtimeVersion()

Get the runtimeVersion property: 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.

Returns:

the runtimeVersion value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SiteAuthSettingsInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

tokenRefreshExtensionHours

public Double tokenRefreshExtensionHours()

Get the tokenRefreshExtensionHours property: 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.

Returns:

the tokenRefreshExtensionHours value.

tokenStoreEnabled

public Boolean tokenStoreEnabled()

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

Returns:

the tokenStoreEnabled value.

twitterConsumerKey

public String twitterConsumerKey()

Get the twitterConsumerKey property: 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.

Returns:

the twitterConsumerKey value.

twitterConsumerSecret

public String twitterConsumerSecret()

Get the twitterConsumerSecret property: 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.

Returns:

the twitterConsumerSecret value.

twitterConsumerSecretSettingName

public String twitterConsumerSecretSettingName()

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

Returns:

the twitterConsumerSecretSettingName value.

type

public String type()

Get the type property: The type of the resource.

Overrides:

SiteAuthSettingsInner.type()

Returns:

the type value.

unauthenticatedClientAction

public UnauthenticatedClientAction unauthenticatedClientAction()

Get the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.

Returns:

the unauthenticatedClientAction value.

validate

public void validate()

Validates the instance.

Overrides:

SiteAuthSettingsInner.validate()

validateIssuer

public Boolean validateIssuer()

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

Returns:

the validateIssuer value.

withAadClaimsAuthorization

public SiteAuthSettingsInner withAadClaimsAuthorization(String aadClaimsAuthorization)

Set the aadClaimsAuthorization property: Gets a JSON string containing the Azure AD Acl settings.

Parameters:

aadClaimsAuthorization - the aadClaimsAuthorization value to set.

Returns:

the SiteAuthSettingsInner object itself.

withAdditionalLoginParams

public SiteAuthSettingsInner withAdditionalLoginParams(List additionalLoginParams)

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

Parameters:

additionalLoginParams - the additionalLoginParams value to set.

Returns:

the SiteAuthSettingsInner object itself.

withAllowedAudiences

public SiteAuthSettingsInner withAllowedAudiences(List allowedAudiences)

Set the allowedAudiences property: 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.

Parameters:

allowedAudiences - the allowedAudiences value to set.

Returns:

the SiteAuthSettingsInner object itself.

withAllowedExternalRedirectUrls

public SiteAuthSettingsInner withAllowedExternalRedirectUrls(List allowedExternalRedirectUrls)

Set the allowedExternalRedirectUrls property: 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.

Parameters:

allowedExternalRedirectUrls - the allowedExternalRedirectUrls value to set.

Returns:

the SiteAuthSettingsInner object itself.

withAuthFilePath

public SiteAuthSettingsInner withAuthFilePath(String authFilePath)

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

Parameters:

authFilePath - the authFilePath value to set.

Returns:

the SiteAuthSettingsInner object itself.

withClientId

public SiteAuthSettingsInner withClientId(String clientId)

Set the clientId property: 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.

Parameters:

clientId - the clientId value to set.

Returns:

the SiteAuthSettingsInner object itself.

withClientSecret

public SiteAuthSettingsInner withClientSecret(String clientSecret)

Set the clientSecret property: 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.

Parameters:

clientSecret - the clientSecret value to set.

Returns:

the SiteAuthSettingsInner object itself.

withClientSecretCertificateThumbprint

public SiteAuthSettingsInner withClientSecretCertificateThumbprint(String clientSecretCertificateThumbprint)

Set the clientSecretCertificateThumbprint property: 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.

Parameters:

clientSecretCertificateThumbprint - the clientSecretCertificateThumbprint value to set.

Returns:

the SiteAuthSettingsInner object itself.

withClientSecretSettingName

public SiteAuthSettingsInner withClientSecretSettingName(String clientSecretSettingName)

Set the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.

Parameters:

clientSecretSettingName - the clientSecretSettingName value to set.

Returns:

the SiteAuthSettingsInner object itself.

withConfigVersion

public SiteAuthSettingsInner withConfigVersion(String configVersion)

Set the configVersion property: 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.

Parameters:

configVersion - the configVersion value to set.

Returns:

the SiteAuthSettingsInner object itself.

withDefaultProvider

public SiteAuthSettingsInner withDefaultProvider(BuiltInAuthenticationProvider defaultProvider)

Set the defaultProvider property: 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".

Parameters:

defaultProvider - the defaultProvider value to set.

Returns:

the SiteAuthSettingsInner object itself.

withEnabled

public SiteAuthSettingsInner withEnabled(Boolean enabled)

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

Parameters:

enabled - the enabled value to set.

Returns:

the SiteAuthSettingsInner object itself.

withFacebookAppId

public SiteAuthSettingsInner withFacebookAppId(String facebookAppId)

Set the facebookAppId property: 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.

Parameters:

facebookAppId - the facebookAppId value to set.

Returns:

the SiteAuthSettingsInner object itself.

withFacebookAppSecret

public SiteAuthSettingsInner withFacebookAppSecret(String facebookAppSecret)

Set the facebookAppSecret property: 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.

Parameters:

facebookAppSecret - the facebookAppSecret value to set.

Returns:

the SiteAuthSettingsInner object itself.

withFacebookAppSecretSettingName

public SiteAuthSettingsInner withFacebookAppSecretSettingName(String facebookAppSecretSettingName)

Set the facebookAppSecretSettingName property: The app setting name that contains the app secret used for Facebook Login.

Parameters:

facebookAppSecretSettingName - the facebookAppSecretSettingName value to set.

Returns:

the SiteAuthSettingsInner object itself.

withFacebookOAuthScopes

public SiteAuthSettingsInner withFacebookOAuthScopes(List facebookOAuthScopes)

Set the facebookOAuthScopes property: 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.

Parameters:

facebookOAuthScopes - the facebookOAuthScopes value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGitHubClientId

public SiteAuthSettingsInner withGitHubClientId(String gitHubClientId)

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

Parameters:

gitHubClientId - the gitHubClientId value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGitHubClientSecret

public SiteAuthSettingsInner withGitHubClientSecret(String gitHubClientSecret)

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

Parameters:

gitHubClientSecret - the gitHubClientSecret value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGitHubClientSecretSettingName

public SiteAuthSettingsInner withGitHubClientSecretSettingName(String gitHubClientSecretSettingName)

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

Parameters:

gitHubClientSecretSettingName - the gitHubClientSecretSettingName value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGitHubOAuthScopes

public SiteAuthSettingsInner withGitHubOAuthScopes(List gitHubOAuthScopes)

Set the gitHubOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional.

Parameters:

gitHubOAuthScopes - the gitHubOAuthScopes value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGoogleClientId

public SiteAuthSettingsInner withGoogleClientId(String googleClientId)

Set the googleClientId property: 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/.

Parameters:

googleClientId - the googleClientId value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGoogleClientSecret

public SiteAuthSettingsInner withGoogleClientSecret(String googleClientSecret)

Set the googleClientSecret property: 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/.

Parameters:

googleClientSecret - the googleClientSecret value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGoogleClientSecretSettingName

public SiteAuthSettingsInner withGoogleClientSecretSettingName(String googleClientSecretSettingName)

Set the googleClientSecretSettingName property: The app setting name that contains the client secret associated with the Google web application.

Parameters:

googleClientSecretSettingName - the googleClientSecretSettingName value to set.

Returns:

the SiteAuthSettingsInner object itself.

withGoogleOAuthScopes

public SiteAuthSettingsInner withGoogleOAuthScopes(List googleOAuthScopes)

Set the googleOAuthScopes property: 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/.

Parameters:

googleOAuthScopes - the googleOAuthScopes value to set.

Returns:

the SiteAuthSettingsInner object itself.

withIsAuthFromFile

public SiteAuthSettingsInner withIsAuthFromFile(String isAuthFromFile)

Set the isAuthFromFile property: "true" if the auth config settings should be read from a file, "false" otherwise.

Parameters:

isAuthFromFile - the isAuthFromFile value to set.

Returns:

the SiteAuthSettingsInner object itself.

withIssuer

public SiteAuthSettingsInner withIssuer(String issuer)

Set the issuer property: 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.

Parameters:

issuer - the issuer value to set.

Returns:

the SiteAuthSettingsInner object itself.

withKind

public SiteAuthSettingsInner withKind(String kind)

Set the kind property: Kind of resource.

Overrides:

SiteAuthSettingsInner.withKind(String kind)

Parameters:

kind

withMicrosoftAccountClientId

public SiteAuthSettingsInner withMicrosoftAccountClientId(String microsoftAccountClientId)

Set the microsoftAccountClientId property: 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.

Parameters:

microsoftAccountClientId - the microsoftAccountClientId value to set.

Returns:

the SiteAuthSettingsInner object itself.

withMicrosoftAccountClientSecret

public SiteAuthSettingsInner withMicrosoftAccountClientSecret(String microsoftAccountClientSecret)

Set the microsoftAccountClientSecret property: 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.

Parameters:

microsoftAccountClientSecret - the microsoftAccountClientSecret value to set.

Returns:

the SiteAuthSettingsInner object itself.

withMicrosoftAccountClientSecretSettingName

public SiteAuthSettingsInner withMicrosoftAccountClientSecretSettingName(String microsoftAccountClientSecretSettingName)

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

Parameters:

microsoftAccountClientSecretSettingName - the microsoftAccountClientSecretSettingName value to set.

Returns:

the SiteAuthSettingsInner object itself.

withMicrosoftAccountOAuthScopes

public SiteAuthSettingsInner withMicrosoftAccountOAuthScopes(List microsoftAccountOAuthScopes)

Set the microsoftAccountOAuthScopes property: 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.

Parameters:

microsoftAccountOAuthScopes - the microsoftAccountOAuthScopes value to set.

Returns:

the SiteAuthSettingsInner object itself.

withRuntimeVersion

public SiteAuthSettingsInner withRuntimeVersion(String runtimeVersion)

Set the runtimeVersion property: 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.

Parameters:

runtimeVersion - the runtimeVersion value to set.

Returns:

the SiteAuthSettingsInner object itself.

withTokenRefreshExtensionHours

public SiteAuthSettingsInner withTokenRefreshExtensionHours(Double tokenRefreshExtensionHours)

Set the tokenRefreshExtensionHours property: 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.

Parameters:

tokenRefreshExtensionHours - the tokenRefreshExtensionHours value to set.

Returns:

the SiteAuthSettingsInner object itself.

withTokenStoreEnabled

public SiteAuthSettingsInner withTokenStoreEnabled(Boolean tokenStoreEnabled)

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

Parameters:

tokenStoreEnabled - the tokenStoreEnabled value to set.

Returns:

the SiteAuthSettingsInner object itself.

withTwitterConsumerKey

public SiteAuthSettingsInner withTwitterConsumerKey(String twitterConsumerKey)

Set the twitterConsumerKey property: 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.

Parameters:

twitterConsumerKey - the twitterConsumerKey value to set.

Returns:

the SiteAuthSettingsInner object itself.

withTwitterConsumerSecret

public SiteAuthSettingsInner withTwitterConsumerSecret(String twitterConsumerSecret)

Set the twitterConsumerSecret property: 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.

Parameters:

twitterConsumerSecret - the twitterConsumerSecret value to set.

Returns:

the SiteAuthSettingsInner object itself.

withTwitterConsumerSecretSettingName

public SiteAuthSettingsInner withTwitterConsumerSecretSettingName(String twitterConsumerSecretSettingName)

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

Parameters:

twitterConsumerSecretSettingName - the twitterConsumerSecretSettingName value to set.

Returns:

the SiteAuthSettingsInner object itself.

withUnauthenticatedClientAction

public SiteAuthSettingsInner withUnauthenticatedClientAction(UnauthenticatedClientAction unauthenticatedClientAction)

Set the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.

Parameters:

unauthenticatedClientAction - the unauthenticatedClientAction value to set.

Returns:

the SiteAuthSettingsInner object itself.

withValidateIssuer

public SiteAuthSettingsInner withValidateIssuer(Boolean validateIssuer)

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

Parameters:

validateIssuer - the validateIssuer value to set.

Returns:

the SiteAuthSettingsInner object itself.