SiteAuthSettings Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Configuration settings for the Azure App Service Authentication / Authorization feature. Serialized Name: SiteAuthSettings
public class SiteAuthSettings : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppService.Models.SiteAuthSettings>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppService.Models.SiteAuthSettings>type SiteAuthSettings = class
inherit ResourceData
interface IJsonModel<SiteAuthSettings>
interface IPersistableModel<SiteAuthSettings>Public Class SiteAuthSettings
Inherits ResourceData
Implements IJsonModel(Of SiteAuthSettings), IPersistableModel(Of SiteAuthSettings)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| SiteAuthSettings() |
Initializes a new instance of SiteAuthSettings. |
Properties
| Name | Description |
|---|---|
| AadClaimsAuthorization |
Gets a JSON string containing the Azure AD Acl settings. Serialized Name: SiteAuthSettings.properties.aadClaimsAuthorization |
| AdditionalLoginParams |
Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value". Serialized Name: SiteAuthSettings.properties.additionalLoginParams |
| AllowedAudiences |
Allowed audience values to consider when validating JSON Web Tokens issued by Azure Active Directory. Note that the <code>ClientID</code> value is always considered an allowed audience, regardless of this setting. Serialized Name: SiteAuthSettings.properties.allowedAudiences |
| AllowedExternalRedirectUrls |
External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed. Serialized Name: SiteAuthSettings.properties.allowedExternalRedirectUrls |
| AuthFilePath |
The path of the config file containing auth settings. If the path is relative, base will the site's root directory. Serialized Name: SiteAuthSettings.properties.authFilePath |
| ClientId |
The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html Serialized Name: SiteAuthSettings.properties.clientId |
| ClientSecret |
The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html Serialized Name: SiteAuthSettings.properties.clientSecret |
| ClientSecretCertificateThumbprintString |
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. Serialized Name: SiteAuthSettings.properties.clientSecretCertificateThumbprint |
| ClientSecretSettingName |
The app setting name that contains the client secret of the relying party application. Serialized Name: SiteAuthSettings.properties.clientSecretSettingName |
| ConfigVersion |
The ConfigVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of the control plane for Authentication / Authorization. Serialized Name: SiteAuthSettings.properties.configVersion |
| DefaultProvider |
The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". Serialized Name: SiteAuthSettings.properties.defaultProvider |
| FacebookAppId |
The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login Serialized Name: SiteAuthSettings.properties.facebookAppId |
| FacebookAppSecret |
The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login Serialized Name: SiteAuthSettings.properties.facebookAppSecret |
| FacebookAppSecretSettingName |
The app setting name that contains the app secret used for Facebook Login. Serialized Name: SiteAuthSettings.properties.facebookAppSecretSettingName |
| FacebookOAuthScopes |
The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login Serialized Name: SiteAuthSettings.properties.facebookOAuthScopes |
| GitHubClientId |
The Client Id of the GitHub app used for login. This setting is required for enabling Github login Serialized Name: SiteAuthSettings.properties.gitHubClientId |
| GitHubClientSecret |
The Client Secret of the GitHub app used for Github Login. This setting is required for enabling Github login. Serialized Name: SiteAuthSettings.properties.gitHubClientSecret |
| GitHubClientSecretSettingName |
The app setting name that contains the client secret of the Github app used for GitHub Login. Serialized Name: SiteAuthSettings.properties.gitHubClientSecretSettingName |
| GitHubOAuthScopes |
The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication. This setting is optional Serialized Name: SiteAuthSettings.properties.gitHubOAuthScopes |
| GoogleClientId |
The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ Serialized Name: SiteAuthSettings.properties.googleClientId |
| GoogleClientSecret |
The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ Serialized Name: SiteAuthSettings.properties.googleClientSecret |
| GoogleClientSecretSettingName |
The app setting name that contains the client secret associated with the Google web application. Serialized Name: SiteAuthSettings.properties.googleClientSecretSettingName |
| GoogleOAuthScopes |
The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/ Serialized Name: SiteAuthSettings.properties.googleOAuthScopes |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| IsAuthFromFile |
"true" if the auth config settings should be read from a file, "false" otherwise Serialized Name: SiteAuthSettings.properties.isAuthFromFile |
| IsEnabled |
<code>true</code> if the Authentication / Authorization feature is enabled for the current app; otherwise, <code>false</code>. Serialized Name: SiteAuthSettings.properties.enabled |
| Issuer |
The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.
When using Azure Active Directory, this value is the URI of the directory tenant, e.g. |
| IsTokenStoreEnabled |
<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>. Serialized Name: SiteAuthSettings.properties.tokenStoreEnabled |
| Kind |
Kind of resource. Serialized Name: ProxyOnlyResource.kind |
| MicrosoftAccountClientId |
The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm Serialized Name: SiteAuthSettings.properties.microsoftAccountClientId |
| MicrosoftAccountClientSecret |
The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm Serialized Name: SiteAuthSettings.properties.microsoftAccountClientSecret |
| MicrosoftAccountClientSecretSettingName |
The app setting name containing the OAuth 2.0 client secret that was created for the app used for authentication. Serialized Name: SiteAuthSettings.properties.microsoftAccountClientSecretSettingName |
| MicrosoftAccountOAuthScopes |
The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx Serialized Name: SiteAuthSettings.properties.microsoftAccountOAuthScopes |
| Name |
The name of the resource. (Inherited from ResourceData) |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| RuntimeVersion |
The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module. Serialized Name: SiteAuthSettings.properties.runtimeVersion |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| TokenRefreshExtensionHours |
The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours. Serialized Name: SiteAuthSettings.properties.tokenRefreshExtensionHours |
| TwitterConsumerKey |
The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in Serialized Name: SiteAuthSettings.properties.twitterConsumerKey |
| TwitterConsumerSecret |
The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in Serialized Name: SiteAuthSettings.properties.twitterConsumerSecret |
| TwitterConsumerSecretSettingName |
The app setting name that contains the OAuth 1.0a consumer secret of the Twitter application used for sign-in. Serialized Name: SiteAuthSettings.properties.twitterConsumerSecretSettingName |
| UnauthenticatedClientAction |
The action to take when an unauthenticated client attempts to access the app. Serialized Name: SiteAuthSettings.properties.unauthenticatedClientAction |
| ValidateIssuer |
Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such. Serialized Name: SiteAuthSettings.properties.validateIssuer |
Methods
| Name | Description |
|---|---|
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
Explicit Interface Implementations
| Name | Description |
|---|---|
| IJsonModel<SiteAuthSettings>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<SiteAuthSettings>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<SiteAuthSettings>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<SiteAuthSettings>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<SiteAuthSettings>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
