ListWebAppAuthSettingsResult

data class ListWebAppAuthSettingsResult(val aadClaimsAuthorization: String? = null, val additionalLoginParams: List<String>? = null, val allowedAudiences: List<String>? = null, val allowedExternalRedirectUrls: List<String>? = null, val authFilePath: String? = null, val clientId: String? = null, val clientSecret: String? = null, val clientSecretCertificateThumbprint: String? = null, val clientSecretSettingName: String? = null, val configVersion: String? = null, val defaultProvider: String? = null, val enabled: Boolean? = null, val facebookAppId: String? = null, val facebookAppSecret: String? = null, val facebookAppSecretSettingName: String? = null, val facebookOAuthScopes: List<String>? = null, val gitHubClientId: String? = null, val gitHubClientSecret: String? = null, val gitHubClientSecretSettingName: String? = null, val gitHubOAuthScopes: List<String>? = null, val googleClientId: String? = null, val googleClientSecret: String? = null, val googleClientSecretSettingName: String? = null, val googleOAuthScopes: List<String>? = null, val id: String, val isAuthFromFile: String? = null, val issuer: String? = null, val kind: String? = null, val microsoftAccountClientId: String? = null, val microsoftAccountClientSecret: String? = null, val microsoftAccountClientSecretSettingName: String? = null, val microsoftAccountOAuthScopes: List<String>? = null, val name: String, val runtimeVersion: String? = null, val tokenRefreshExtensionHours: Double? = null, val tokenStoreEnabled: Boolean? = null, val twitterConsumerKey: String? = null, val twitterConsumerSecret: String? = null, val twitterConsumerSecretSettingName: String? = null, val type: String, val unauthenticatedClientAction: String? = null, val validateIssuer: Boolean? = null)

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

Constructors

Link copied to clipboard
constructor(aadClaimsAuthorization: String? = null, additionalLoginParams: List<String>? = null, allowedAudiences: List<String>? = null, allowedExternalRedirectUrls: List<String>? = null, authFilePath: String? = null, clientId: String? = null, clientSecret: String? = null, clientSecretCertificateThumbprint: String? = null, clientSecretSettingName: String? = null, configVersion: String? = null, defaultProvider: String? = null, enabled: Boolean? = null, facebookAppId: String? = null, facebookAppSecret: String? = null, facebookAppSecretSettingName: String? = null, facebookOAuthScopes: List<String>? = null, gitHubClientId: String? = null, gitHubClientSecret: String? = null, gitHubClientSecretSettingName: String? = null, gitHubOAuthScopes: List<String>? = null, googleClientId: String? = null, googleClientSecret: String? = null, googleClientSecretSettingName: String? = null, googleOAuthScopes: List<String>? = null, id: String, isAuthFromFile: String? = null, issuer: String? = null, kind: String? = null, microsoftAccountClientId: String? = null, microsoftAccountClientSecret: String? = null, microsoftAccountClientSecretSettingName: String? = null, microsoftAccountOAuthScopes: List<String>? = null, name: String, runtimeVersion: String? = null, tokenRefreshExtensionHours: Double? = null, tokenStoreEnabled: Boolean? = null, twitterConsumerKey: String? = null, twitterConsumerSecret: String? = null, twitterConsumerSecretSettingName: String? = null, type: String, unauthenticatedClientAction: String? = null, validateIssuer: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Gets a JSON string containing the Azure AD Acl settings.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val authFilePath: String? = null

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

Link copied to clipboard
val clientId: String? = null

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

Link copied to clipboard
val clientSecret: String? = null

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val configVersion: String? = null

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.

Link copied to clipboard
val defaultProvider: String? = null

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

Link copied to clipboard
val enabled: Boolean? = null

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

Link copied to clipboard
val facebookAppId: String? = null

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val gitHubClientId: String? = null

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val googleClientId: String? = null

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/

Link copied to clipboard

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/

Link copied to clipboard

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

Link copied to clipboard

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/

Link copied to clipboard
val id: String

Resource Id.

Link copied to clipboard
val isAuthFromFile: String? = null

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

Link copied to clipboard
val issuer: String? = null

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

Link copied to clipboard
val kind: String? = null

Kind of resource.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Resource Name.

Link copied to clipboard
val runtimeVersion: String? = null

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Resource type.

Link copied to clipboard

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

Link copied to clipboard
val validateIssuer: Boolean? = null

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