SiteAuthSettingsProperties (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.resourcemanager.appservice.fluent.models.SiteAuthSettingsProperties

public final class SiteAuthSettingsProperties
extends Object

SiteAuthSettings resource specific properties.

Constructor Summary

Constructors
Constructor and Description

SiteAuthSettingsProperties()

Constructors
Constructor and Description
`SiteAuthSettingsProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
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 JWTs 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: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
`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.
`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`	`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`	`runtimeVersion()` Get the runtimeVersion property: The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
`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: <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
`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.
`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.
`SiteAuthSettingsProperties`	`withAadClaimsAuthorization(String aadClaimsAuthorization)` Set the aadClaimsAuthorization property: Gets a JSON string containing the Azure AD Acl settings.
`SiteAuthSettingsProperties`	`withAdditionalLoginParams(List<String> additionalLoginParams)` Set the additionalLoginParams property: Login parameters to send to the OpenID Connect authorization endpoint when a user logs in.
`SiteAuthSettingsProperties`	`withAllowedAudiences(List<String> allowedAudiences)` Set the allowedAudiences property: Allowed audience values to consider when validating JWTs issued by Azure Active Directory.
`SiteAuthSettingsProperties`	`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.
`SiteAuthSettingsProperties`	`withAuthFilePath(String authFilePath)` Set the authFilePath property: The path of the config file containing auth settings.
`SiteAuthSettingsProperties`	`withClientId(String clientId)` Set the clientId property: The Client ID of this relying party application, known as the client_id.
`SiteAuthSettingsProperties`	`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).
`SiteAuthSettingsProperties`	`withClientSecretCertificateThumbprint(String clientSecretCertificateThumbprint)` Set the clientSecretCertificateThumbprint property: An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes.
`SiteAuthSettingsProperties`	`withClientSecretSettingName(String clientSecretSettingName)` Set the clientSecretSettingName property: The app setting name that contains the client secret of the relying party application.
`SiteAuthSettingsProperties`	`withConfigVersion(String configVersion)` Set the configVersion property: The ConfigVersion of the Authentication / Authorization feature in use for the current app.
`SiteAuthSettingsProperties`	`withDefaultProvider(BuiltInAuthenticationProvider defaultProvider)` Set the defaultProvider property: The default authentication provider to use when multiple providers are configured.
`SiteAuthSettingsProperties`	`withEnabled(Boolean enabled)` Set the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
`SiteAuthSettingsProperties`	`withFacebookAppId(String facebookAppId)` Set the facebookAppId property: The App ID of the Facebook app used for login.
`SiteAuthSettingsProperties`	`withFacebookAppSecret(String facebookAppSecret)` Set the facebookAppSecret property: The App Secret of the Facebook app used for Facebook Login.
`SiteAuthSettingsProperties`	`withFacebookAppSecretSettingName(String facebookAppSecretSettingName)` Set the facebookAppSecretSettingName property: The app setting name that contains the app secret used for Facebook Login.
`SiteAuthSettingsProperties`	`withFacebookOAuthScopes(List<String> facebookOAuthScopes)` Set the facebookOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.
`SiteAuthSettingsProperties`	`withGitHubClientId(String gitHubClientId)` Set the gitHubClientId property: The Client Id of the GitHub app used for login.
`SiteAuthSettingsProperties`	`withGitHubClientSecret(String gitHubClientSecret)` Set the gitHubClientSecret property: The Client Secret of the GitHub app used for Github Login.
`SiteAuthSettingsProperties`	`withGitHubClientSecretSettingName(String gitHubClientSecretSettingName)` Set the gitHubClientSecretSettingName property: The app setting name that contains the client secret of the Github app used for GitHub Login.
`SiteAuthSettingsProperties`	`withGitHubOAuthScopes(List<String> gitHubOAuthScopes)` Set the gitHubOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.
`SiteAuthSettingsProperties`	`withGoogleClientId(String googleClientId)` Set the googleClientId property: The OpenID Connect Client ID for the Google web application.
`SiteAuthSettingsProperties`	`withGoogleClientSecret(String googleClientSecret)` Set the googleClientSecret property: The client secret associated with the Google web application.
`SiteAuthSettingsProperties`	`withGoogleClientSecretSettingName(String googleClientSecretSettingName)` Set the googleClientSecretSettingName property: The app setting name that contains the client secret associated with the Google web application.
`SiteAuthSettingsProperties`	`withGoogleOAuthScopes(List<String> googleOAuthScopes)` Set the googleOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.
`SiteAuthSettingsProperties`	`withIsAuthFromFile(String isAuthFromFile)` Set the isAuthFromFile property: "true" if the auth config settings should be read from a file, "false" otherwise.
`SiteAuthSettingsProperties`	`withIssuer(String issuer)` Set the issuer property: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
`SiteAuthSettingsProperties`	`withMicrosoftAccountClientId(String microsoftAccountClientId)` Set the microsoftAccountClientId property: The OAuth 2.0 client ID that was created for the app used for authentication.
`SiteAuthSettingsProperties`	`withMicrosoftAccountClientSecret(String microsoftAccountClientSecret)` Set the microsoftAccountClientSecret property: The OAuth 2.0 client secret that was created for the app used for authentication.
`SiteAuthSettingsProperties`	`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.
`SiteAuthSettingsProperties`	`withMicrosoftAccountOAuthScopes(List<String> microsoftAccountOAuthScopes)` Set the microsoftAccountOAuthScopes property: The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.
`SiteAuthSettingsProperties`	`withRuntimeVersion(String runtimeVersion)` Set the runtimeVersion property: The RuntimeVersion of the Authentication / Authorization feature in use for the current app.
`SiteAuthSettingsProperties`	`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.
`SiteAuthSettingsProperties`	`withTokenStoreEnabled(Boolean tokenStoreEnabled)` Set the tokenStoreEnabled property: <code>true</code> to durably store platform-specific security tokens that are obtained during login flows; otherwise, <code>false</code>.
`SiteAuthSettingsProperties`	`withTwitterConsumerKey(String twitterConsumerKey)` Set the twitterConsumerKey property: The OAuth 1.0a consumer key of the Twitter application used for sign-in.
`SiteAuthSettingsProperties`	`withTwitterConsumerSecret(String twitterConsumerSecret)` Set the twitterConsumerSecret property: The OAuth 1.0a consumer secret of the Twitter application used for sign-in.
`SiteAuthSettingsProperties`	`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.
`SiteAuthSettingsProperties`	`withUnauthenticatedClientAction(UnauthenticatedClientAction unauthenticatedClientAction)` Set the unauthenticatedClientAction property: The action to take when an unauthenticated client attempts to access the app.
`SiteAuthSettingsProperties`	`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SiteAuthSettingsProperties
```
public SiteAuthSettingsProperties()
```
- Method Detail
  - enabled
```
public Boolean enabled()
```
    Get the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
    
    Returns:
    
    the enabled value.
  - withEnabled
```
public SiteAuthSettingsProperties withEnabled(Boolean enabled)
```
    Set the enabled property: <code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>.
    
    Parameters:
    
    enabled - the enabled value to set.
    
    Returns:
    
    the SiteAuthSettingsProperties object itself.
  - 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.
  - withRuntimeVersion
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withUnauthenticatedClientAction
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - tokenStoreEnabled
```
public Boolean tokenStoreEnabled()
```
    Get the tokenStoreEnabled property: <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>.
    
    Returns:
    
    the tokenStoreEnabled value.
  - withTokenStoreEnabled
```
public SiteAuthSettingsProperties withTokenStoreEnabled(Boolean tokenStoreEnabled)
```
    Set the tokenStoreEnabled property: <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>.
    
    Parameters:
    
    tokenStoreEnabled - the tokenStoreEnabled value to set.
    
    Returns:
    
    the SiteAuthSettingsProperties object itself.
  - allowedExternalRedirectUrls
```
public 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. 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.
  - withAllowedExternalRedirectUrls
```
public SiteAuthSettingsProperties 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. 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withDefaultProvider
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withTokenRefreshExtensionHours
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withClientId
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withClientSecret
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withClientSecretSettingName
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withClientSecretCertificateThumbprint
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withIssuer
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withValidateIssuer
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - allowedAudiences
```
public List<String> allowedAudiences()
```
    Get the allowedAudiences property: 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.
    
    Returns:
    
    the allowedAudiences value.
  - withAllowedAudiences
```
public SiteAuthSettingsProperties withAllowedAudiences(List<String> allowedAudiences)
```
    Set the allowedAudiences property: 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.
    
    Parameters:
    
    allowedAudiences - the allowedAudiences value to set.
    
    Returns:
    
    the SiteAuthSettingsProperties object itself.
  - additionalLoginParams
```
public List<String> 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.
  - withAdditionalLoginParams
```
public SiteAuthSettingsProperties withAdditionalLoginParams(List<String> 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 SiteAuthSettingsProperties object itself.
  - aadClaimsAuthorization
```
public String aadClaimsAuthorization()
```
    Get the aadClaimsAuthorization property: Gets a JSON string containing the Azure AD Acl settings.
    
    Returns:
    
    the aadClaimsAuthorization value.
  - withAadClaimsAuthorization
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withGoogleClientId
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withGoogleClientSecret
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withGoogleClientSecretSettingName
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - googleOAuthScopes
```
public List<String> 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.
  - withGoogleOAuthScopes
```
public SiteAuthSettingsProperties withGoogleOAuthScopes(List<String> 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withFacebookAppId
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withFacebookAppSecret
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withFacebookAppSecretSettingName
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - facebookOAuthScopes
```
public List<String> 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.
  - withFacebookOAuthScopes
```
public SiteAuthSettingsProperties withFacebookOAuthScopes(List<String> 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withGitHubClientId
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withGitHubClientSecret
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withGitHubClientSecretSettingName
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - gitHubOAuthScopes
```
public List<String> 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.
  - withGitHubOAuthScopes
```
public SiteAuthSettingsProperties withGitHubOAuthScopes(List<String> 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withTwitterConsumerKey
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withTwitterConsumerSecret
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withTwitterConsumerSecretSettingName
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withMicrosoftAccountClientId
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withMicrosoftAccountClientSecret
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withMicrosoftAccountClientSecretSettingName
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - microsoftAccountOAuthScopes
```
public List<String> 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.
  - withMicrosoftAccountOAuthScopes
```
public SiteAuthSettingsProperties withMicrosoftAccountOAuthScopes(List<String> 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withIsAuthFromFile
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withAuthFilePath
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - 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.
  - withConfigVersion
```
public SiteAuthSettingsProperties 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 SiteAuthSettingsProperties object itself.
  - validate
```
public void validate()
```
    Validates the instance.
    
    Throws:
    
    IllegalArgumentException - thrown if the instance is not valid.

Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.

Class SiteAuthSettingsProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SiteAuthSettingsProperties

Method Detail

enabled

withEnabled

runtimeVersion

withRuntimeVersion

unauthenticatedClientAction

withUnauthenticatedClientAction

tokenStoreEnabled

withTokenStoreEnabled

allowedExternalRedirectUrls

withAllowedExternalRedirectUrls

defaultProvider

withDefaultProvider

tokenRefreshExtensionHours

withTokenRefreshExtensionHours

clientId

withClientId

clientSecret

withClientSecret

clientSecretSettingName

withClientSecretSettingName

clientSecretCertificateThumbprint

withClientSecretCertificateThumbprint

issuer

withIssuer

validateIssuer

withValidateIssuer

allowedAudiences

withAllowedAudiences

additionalLoginParams

withAdditionalLoginParams

aadClaimsAuthorization

withAadClaimsAuthorization

googleClientId

withGoogleClientId

googleClientSecret

withGoogleClientSecret

googleClientSecretSettingName

withGoogleClientSecretSettingName

googleOAuthScopes

withGoogleOAuthScopes

facebookAppId

withFacebookAppId

facebookAppSecret

withFacebookAppSecret

facebookAppSecretSettingName

withFacebookAppSecretSettingName

facebookOAuthScopes

withFacebookOAuthScopes

gitHubClientId

withGitHubClientId

gitHubClientSecret

withGitHubClientSecret

gitHubClientSecretSettingName

withGitHubClientSecretSettingName

gitHubOAuthScopes

withGitHubOAuthScopes

twitterConsumerKey

withTwitterConsumerKey

twitterConsumerSecret

withTwitterConsumerSecret

twitterConsumerSecretSettingName

withTwitterConsumerSecretSettingName

microsoftAccountClientId

withMicrosoftAccountClientId

microsoftAccountClientSecret

withMicrosoftAccountClientSecret

microsoftAccountClientSecretSettingName

withMicrosoftAccountClientSecretSettingName

microsoftAccountOAuthScopes

withMicrosoftAccountOAuthScopes

isAuthFromFile

withIsAuthFromFile

authFilePath