Package org.bonitasoft.web.client.api

Interface PortalAuthenticationApi

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static class  PortalAuthenticationApi.LogoutQueryParams
      A convenience class for generating query parameters for the logout method in a fluent style.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      feign.Response login​(String username, String password, String tenant, String redirect, String redirectURL)
      Login A call to the `/loginservice` will generates a set-cookie header in the response.
      void logout​(String redirect)
      Logout the current user Logout the current user from the system
      void logout​(Map<String,​Object> queryParams)
      Logout the current user Logout the current user from the system Note, this is equivalent to the other logout method, but with the query parameters collected into a single Map parameter.

    • Method Detail

      • login

        feign.Response login​(String username,
                     String password,
                     String tenant,
                     String redirect,
                     String redirectURL)
        Login A call to the `/loginservice` will generates a set-cookie header in the response. The `JSESSIONID` cookie must be transfered with each subsequent calls. (If the REST API is used in an application running in a web browser, this is handled automatically by the web browser just like any cookies). Additional protection agains CSRF attacks is enabled by default for all fresh installations This security relies on `X-Bonita-API-Token` information. The `X-Bonita-API-Token` value can be found in the cookie named: `X-Bonita-API-Token`. All the subsequence REST API calls performing changes in the system using DELETE, POST, or PUT HTTP methods must contain the **HTTP header** below: ``` X-Bonita-API-Token: example-dummy-not-be-used-value ```
        Parameters:
        username - the username (required)
        password - the password (required)
        tenant - the user tenant (optional)
        redirect - \\\"true\\\" or \\\"false\\\". \\\"false\\\" indicates that the service should not redirect to Bonita Portal (after a successful login) or to the login page (after a login failure). (optional, default to "false")
        redirectURL - the URL of the page to be displayed after login (optional, default to "")
        Returns:
        String

      • logout

        void logout​(String redirect)
        Logout the current user Logout the current user from the system
        Parameters:
        redirect - Setting the redirect parameter to false indicates that the service should not redirect to the login page after logging out. (optional)

      • logout

        void logout​(Map<String,​Object> queryParams)
        Logout the current user Logout the current user from the system Note, this is equivalent to the other logout method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the PortalAuthenticationApi.LogoutQueryParams class that allows for building up this map in a fluent style.
        Parameters:
        queryParams - Map of query parameters as name-value pairs

        The following elements may be specified in the query map:

        • redirect - Setting the redirect parameter to false indicates that the service should not redirect to the login page after logging out. (optional)