Share via


Login Class

  • java.lang.Object
    • com.azure.resourcemanager.appservice.models.Login

Implements

public final class Login
implements JsonSerializable<Login>

The configuration settings of the login flow of users using App Service Authentication/Authorization.

Constructor Summary

Constructor Description
Login()

Creates an instance of Login class.

Method Summary

Modifier and Type Method and Description
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.

CookieExpiration cookieExpiration()

Get the cookieExpiration property: The configuration settings of the session cookie's expiration.

static Login fromJson(JsonReader jsonReader)

Reads an instance of Login from the JsonReader.

Nonce nonce()

Get the nonce property: The configuration settings of the nonce used in the login flow.

Boolean preserveUrlFragmentsForLogins()

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

LoginRoutes routes()

Get the routes property: The routes that specify the endpoints used for login and logout requests.

JsonWriter toJson(JsonWriter jsonWriter)
TokenStore tokenStore()

Get the tokenStore property: The configuration settings of the token store.

void validate()

Validates the instance.

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

Login withCookieExpiration(CookieExpiration cookieExpiration)

Set the cookieExpiration property: The configuration settings of the session cookie's expiration.

Login withNonce(Nonce nonce)

Set the nonce property: The configuration settings of the nonce used in the login flow.

Login withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)

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

Login withRoutes(LoginRoutes routes)

Set the routes property: The routes that specify the endpoints used for login and logout requests.

Login withTokenStore(TokenStore tokenStore)

Set the tokenStore property: The configuration settings of the token store.

Methods inherited from java.lang.Object

Constructor Details

Login

public Login()

Creates an instance of Login class.

Method Details

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.

cookieExpiration

public CookieExpiration cookieExpiration()

Get the cookieExpiration property: The configuration settings of the session cookie's expiration.

Returns:

the cookieExpiration value.

fromJson

public static Login fromJson(JsonReader jsonReader)

Reads an instance of Login from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Login if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the Login.

nonce

public Nonce nonce()

Get the nonce property: The configuration settings of the nonce used in the login flow.

Returns:

the nonce value.

preserveUrlFragmentsForLogins

public Boolean preserveUrlFragmentsForLogins()

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

Returns:

the preserveUrlFragmentsForLogins value.

routes

public LoginRoutes routes()

Get the routes property: The routes that specify the endpoints used for login and logout requests.

Returns:

the routes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

tokenStore

public TokenStore tokenStore()

Get the tokenStore property: The configuration settings of the token store.

Returns:

the tokenStore value.

validate

public void validate()

Validates the instance.

withAllowedExternalRedirectUrls

public Login 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 Login object itself.

withCookieExpiration

public Login withCookieExpiration(CookieExpiration cookieExpiration)

Set the cookieExpiration property: The configuration settings of the session cookie's expiration.

Parameters:

cookieExpiration - the cookieExpiration value to set.

Returns:

the Login object itself.

withNonce

public Login withNonce(Nonce nonce)

Set the nonce property: The configuration settings of the nonce used in the login flow.

Parameters:

nonce - the nonce value to set.

Returns:

the Login object itself.

withPreserveUrlFragmentsForLogins

public Login withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)

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

Parameters:

preserveUrlFragmentsForLogins - the preserveUrlFragmentsForLogins value to set.

Returns:

the Login object itself.

withRoutes

public Login withRoutes(LoginRoutes routes)

Set the routes property: The routes that specify the endpoints used for login and logout requests.

Parameters:

routes - the routes value to set.

Returns:

the Login object itself.

withTokenStore

public Login withTokenStore(TokenStore tokenStore)

Set the tokenStore property: The configuration settings of the token store.

Parameters:

tokenStore - the tokenStore value to set.

Returns:

the Login object itself.

Applies to