Share via


AuthConfigProperties Class

Definition

AuthConfig resource specific properties

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.AuthConfigPropertiesTypeConverter))]
public class AuthConfigProperties : Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAuthConfigProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.App.Models.AuthConfigPropertiesTypeConverter))>]
type AuthConfigProperties = class
    interface IAuthConfigProperties
    interface IJsonSerializable
Public Class AuthConfigProperties
Implements IAuthConfigProperties
Inheritance
AuthConfigProperties
Attributes
Implements

Constructors

AuthConfigProperties()

Creates an new AuthConfigProperties instance.

Properties

CookieExpirationConvention

The convention used when determining the session cookie's expiration.

CookieExpirationTimeToExpiration

The time after the request is made when the session cookie should expire.

ForwardProxyConvention

The convention used to determine the url of the request made.

ForwardProxyCustomHostHeaderName

The name of the header containing the host of the request.

ForwardProxyCustomProtoHeaderName

The name of the header containing the scheme of the request.

GlobalValidationExcludedPath

The paths for which unauthenticated flow would not be redirected to the login page.

GlobalValidationRedirectToProvider

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

GlobalValidationUnauthenticatedClientAction

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

HttpSettingRequireHttps

false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true.

IdentityProvider

The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.

LoginAllowedExternalRedirectUrl

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.

LoginPreserveUrlFragmentsForLogin

true if the fragments from the request are preserved after the login request is made; otherwise, false.

NonceExpirationInterval

The time after the request is made when the nonce should expire.

NonceValidateNonce

false if the nonce should not be validated while completing the login flow; otherwise, true.

PlatformEnabled

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

PlatformRuntimeVersion

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.

RouteApiPrefix

The prefix that should precede all the authentication/authorization paths.

RouteLogoutEndpoint

The endpoint at which a logout request should be made.

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of AuthConfigProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of AuthConfigProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.App.Models.IAuthConfigProperties.

FromJsonString(String)

Creates a new instance of AuthConfigProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of AuthConfigProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()

Applies to