Package com.azure.resourcemanager.appcontainers.models

Class Login

java.lang.Object
com.azure.resourcemanager.appcontainers.models.Login
All Implemented Interfaces:
com.azure.json.JsonSerializable<Login>
public final class Login extends Object implements com.azure.json.JsonSerializable<Login>
The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Login()
    Creates an instance of Login class.

  • Method Summary

    Modifier and Type
    Method
    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(com.azure.json.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: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
    LoginRoutes
    routes()
    Get the routes property: The routes that specify the endpoints used for login and logout requests.
    com.azure.json.JsonWriter
    toJson(com.azure.json.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: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
    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 class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • Login

      public Login()
      Creates an instance of Login class.

  • Method Details

    • routes

      public LoginRoutes routes()
      Get the routes property: The routes that specify the endpoints used for login and logout requests.
      Returns:
      the routes value.

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

    • tokenStore

      public TokenStore tokenStore()
      Get the tokenStore property: The configuration settings of the token store.
      Returns:
      the tokenStore value.

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

    • preserveUrlFragmentsForLogins

      public Boolean preserveUrlFragmentsForLogins()
      Get the preserveUrlFragmentsForLogins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
      Returns:
      the preserveUrlFragmentsForLogins value.

    • withPreserveUrlFragmentsForLogins

      public Login withPreserveUrlFragmentsForLogins(Boolean preserveUrlFragmentsForLogins)
      Set the preserveUrlFragmentsForLogins property: <code>true</code> if the fragments from the request are preserved after the login request is made; otherwise, <code>false</code>.
      Parameters:
      preserveUrlFragmentsForLogins - the preserveUrlFragmentsForLogins value to set.
      Returns:
      the Login object itself.

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

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

    • cookieExpiration

      public CookieExpiration cookieExpiration()
      Get the cookieExpiration property: The configuration settings of the session cookie's expiration.
      Returns:
      the cookieExpiration value.

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

    • nonce

      public Nonce nonce()
      Get the nonce property: The configuration settings of the nonce used in the login flow.
      Returns:
      the nonce value.

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

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<Login>
      Throws:
      IOException

    • fromJson

      public static Login fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.