public final class SiteAuthSettingsInner extends ProxyOnlyResource
| Constructor and Description |
|---|
SiteAuthSettingsInner() |
| 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.
|
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 JWTs 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: <code>true</code> if the Authentication / Authorization feature is enabled
for the current app; otherwise, <code>false</code>.
|
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: <code>true</code> to durably store platform-specific security
tokens that are obtained during login flows; otherwise, <code>false</code>.
|
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.
|
kindpublic SiteAuthSettingsInner withKind(String kind)
withKind in class ProxyOnlyResourcekind - the kind value to set.public Boolean enabled()
public SiteAuthSettingsInner withEnabled(Boolean enabled)
enabled - the enabled value to set.public String runtimeVersion()
public SiteAuthSettingsInner withRuntimeVersion(String runtimeVersion)
runtimeVersion - the runtimeVersion value to set.public UnauthenticatedClientAction unauthenticatedClientAction()
public SiteAuthSettingsInner withUnauthenticatedClientAction(UnauthenticatedClientAction unauthenticatedClientAction)
unauthenticatedClientAction - the unauthenticatedClientAction value to set.public Boolean tokenStoreEnabled()
public SiteAuthSettingsInner withTokenStoreEnabled(Boolean tokenStoreEnabled)
tokenStoreEnabled - the tokenStoreEnabled value to set.public List<String> allowedExternalRedirectUrls()
public SiteAuthSettingsInner withAllowedExternalRedirectUrls(List<String> allowedExternalRedirectUrls)
allowedExternalRedirectUrls - the allowedExternalRedirectUrls value to set.public BuiltInAuthenticationProvider defaultProvider()
public SiteAuthSettingsInner withDefaultProvider(BuiltInAuthenticationProvider defaultProvider)
defaultProvider - the defaultProvider value to set.public Double tokenRefreshExtensionHours()
public SiteAuthSettingsInner withTokenRefreshExtensionHours(Double tokenRefreshExtensionHours)
tokenRefreshExtensionHours - the tokenRefreshExtensionHours value to set.public String clientId()
public SiteAuthSettingsInner withClientId(String clientId)
clientId - the clientId value to set.public String clientSecret()
public SiteAuthSettingsInner withClientSecret(String clientSecret)
clientSecret - the clientSecret value to set.public String clientSecretSettingName()
public SiteAuthSettingsInner withClientSecretSettingName(String clientSecretSettingName)
clientSecretSettingName - the clientSecretSettingName value to set.public String clientSecretCertificateThumbprint()
public SiteAuthSettingsInner withClientSecretCertificateThumbprint(String clientSecretCertificateThumbprint)
clientSecretCertificateThumbprint - the clientSecretCertificateThumbprint value to set.public String issuer()
public SiteAuthSettingsInner withIssuer(String issuer)
issuer - the issuer value to set.public Boolean validateIssuer()
public SiteAuthSettingsInner withValidateIssuer(Boolean validateIssuer)
validateIssuer - the validateIssuer value to set.public List<String> allowedAudiences()
public SiteAuthSettingsInner withAllowedAudiences(List<String> allowedAudiences)
allowedAudiences - the allowedAudiences value to set.public List<String> additionalLoginParams()
public SiteAuthSettingsInner withAdditionalLoginParams(List<String> additionalLoginParams)
additionalLoginParams - the additionalLoginParams value to set.public String aadClaimsAuthorization()
public SiteAuthSettingsInner withAadClaimsAuthorization(String aadClaimsAuthorization)
aadClaimsAuthorization - the aadClaimsAuthorization value to set.public String googleClientId()
public SiteAuthSettingsInner withGoogleClientId(String googleClientId)
googleClientId - the googleClientId value to set.public String googleClientSecret()
public SiteAuthSettingsInner withGoogleClientSecret(String googleClientSecret)
googleClientSecret - the googleClientSecret value to set.public String googleClientSecretSettingName()
public SiteAuthSettingsInner withGoogleClientSecretSettingName(String googleClientSecretSettingName)
googleClientSecretSettingName - the googleClientSecretSettingName value to set.public List<String> googleOAuthScopes()
public SiteAuthSettingsInner withGoogleOAuthScopes(List<String> googleOAuthScopes)
googleOAuthScopes - the googleOAuthScopes value to set.public String facebookAppId()
public SiteAuthSettingsInner withFacebookAppId(String facebookAppId)
facebookAppId - the facebookAppId value to set.public String facebookAppSecret()
public SiteAuthSettingsInner withFacebookAppSecret(String facebookAppSecret)
facebookAppSecret - the facebookAppSecret value to set.public String facebookAppSecretSettingName()
public SiteAuthSettingsInner withFacebookAppSecretSettingName(String facebookAppSecretSettingName)
facebookAppSecretSettingName - the facebookAppSecretSettingName value to set.public List<String> facebookOAuthScopes()
public SiteAuthSettingsInner withFacebookOAuthScopes(List<String> facebookOAuthScopes)
facebookOAuthScopes - the facebookOAuthScopes value to set.public String gitHubClientId()
public SiteAuthSettingsInner withGitHubClientId(String gitHubClientId)
gitHubClientId - the gitHubClientId value to set.public String gitHubClientSecret()
public SiteAuthSettingsInner withGitHubClientSecret(String gitHubClientSecret)
gitHubClientSecret - the gitHubClientSecret value to set.public String gitHubClientSecretSettingName()
public SiteAuthSettingsInner withGitHubClientSecretSettingName(String gitHubClientSecretSettingName)
gitHubClientSecretSettingName - the gitHubClientSecretSettingName value to set.public List<String> gitHubOAuthScopes()
public SiteAuthSettingsInner withGitHubOAuthScopes(List<String> gitHubOAuthScopes)
gitHubOAuthScopes - the gitHubOAuthScopes value to set.public String twitterConsumerKey()
public SiteAuthSettingsInner withTwitterConsumerKey(String twitterConsumerKey)
twitterConsumerKey - the twitterConsumerKey value to set.public String twitterConsumerSecret()
public SiteAuthSettingsInner withTwitterConsumerSecret(String twitterConsumerSecret)
twitterConsumerSecret - the twitterConsumerSecret value to set.public String twitterConsumerSecretSettingName()
public SiteAuthSettingsInner withTwitterConsumerSecretSettingName(String twitterConsumerSecretSettingName)
twitterConsumerSecretSettingName - the twitterConsumerSecretSettingName value to set.public String microsoftAccountClientId()
public SiteAuthSettingsInner withMicrosoftAccountClientId(String microsoftAccountClientId)
microsoftAccountClientId - the microsoftAccountClientId value to set.public String microsoftAccountClientSecret()
public SiteAuthSettingsInner withMicrosoftAccountClientSecret(String microsoftAccountClientSecret)
microsoftAccountClientSecret - the microsoftAccountClientSecret value to set.public String microsoftAccountClientSecretSettingName()
public SiteAuthSettingsInner withMicrosoftAccountClientSecretSettingName(String microsoftAccountClientSecretSettingName)
microsoftAccountClientSecretSettingName - the microsoftAccountClientSecretSettingName value to set.public List<String> microsoftAccountOAuthScopes()
public SiteAuthSettingsInner withMicrosoftAccountOAuthScopes(List<String> microsoftAccountOAuthScopes)
microsoftAccountOAuthScopes - the microsoftAccountOAuthScopes value to set.public String isAuthFromFile()
public SiteAuthSettingsInner withIsAuthFromFile(String isAuthFromFile)
isAuthFromFile - the isAuthFromFile value to set.public String authFilePath()
public SiteAuthSettingsInner withAuthFilePath(String authFilePath)
authFilePath - the authFilePath value to set.public String configVersion()
public SiteAuthSettingsInner withConfigVersion(String configVersion)
configVersion - the configVersion value to set.public void validate()
validate in class ProxyOnlyResourceIllegalArgumentException - thrown if the instance is not valid.Copyright © 2021 Microsoft Corporation. All rights reserved.