Package org.bonitasoft.web.client.api

Interface PlatformAuthenticationApi

All Superinterfaces:

ApiClient.Api

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.12.0")
public interface PlatformAuthenticationApi
extends ApiClient.Api

Method Summary

Modifier and Type	Method	Description
void	platformLogin(String username, String password, String redirect)	Platform Login The username and password are in `bonita-platform-community-custom.properties` file.
ApiResponse<Void>	platformLoginWithHttpInfo(String username, String password, String redirect)	Platform Login Similar to platformLogin but it also returns the http response headers .
void	platformLogout()	Platform Logout
ApiResponse<Void>	platformLogoutWithHttpInfo()	Platform Logout Similar to platformLogout but it also returns the http response headers .

Method Details

platformLogin

void platformLogin(String username,
 String password,
 String redirect)

Platform Login The username and password are in `bonita-platform-community-custom.properties` file.

Parameters:

username - the username (optional)

password - the password (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)

platformLoginWithHttpInfo

ApiResponse<Void> platformLoginWithHttpInfo(String username,
 String password,
 String redirect)

Platform Login Similar to platformLogin but it also returns the http response headers . The username and password are in `bonita-platform-community-custom.properties` file.

Parameters:

username - the username (optional)

password - the password (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)

platformLogout

void platformLogout()

Platform Logout

platformLogoutWithHttpInfo

ApiResponse<Void> platformLogoutWithHttpInfo()

Platform Logout Similar to platformLogout but it also returns the http response headers .