Package org.openapitools.client.api

Class AuthApi

java.lang.Object

org.openapitools.client.api.AuthApi

public class AuthApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AuthApi()
AuthApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SlimUser	callback()	OpenID Connect callback OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly.
okhttp3.Call	callbackAsync(ApiCallback<SlimUser> _callback)	OpenID Connect callback (asynchronously) OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly.
okhttp3.Call	callbackCall(ApiCallback _callback)	Build call for callback
ApiResponse<SlimUser>	callbackWithHttpInfo()	OpenID Connect callback OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
SlimUser	getMe()	Get Me Get Me Get the user corresponding to your current auth credentials.
okhttp3.Call	getMeAsync(ApiCallback<SlimUser> _callback)	Get Me (asynchronously) Get Me Get the user corresponding to your current auth credentials.
okhttp3.Call	getMeCall(ApiCallback _callback)	Build call for getMe
ApiResponse<SlimUser>	getMeWithHttpInfo()	Get Me Get Me Get the user corresponding to your current auth credentials.
void	login(AuthQuery content)	Login Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
okhttp3.Call	loginAsync(AuthQuery content, ApiCallback<Void> _callback)	Login (asynchronously) Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
okhttp3.Call	loginCall(AuthQuery content, ApiCallback _callback)	Build call for login
ApiResponse<Void>	loginWithHttpInfo(@NotNull AuthQuery content)	Login Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
void	logout()	Logout Logout Invalidate your current auth credential stored typically stored in a cookie.
okhttp3.Call	logoutAsync(ApiCallback<Void> _callback)	Logout (asynchronously) Logout Invalidate your current auth credential stored typically stored in a cookie.
okhttp3.Call	logoutCall(ApiCallback _callback)	Build call for logout
ApiResponse<Void>	logoutWithHttpInfo()	Logout Logout Invalidate your current auth credential stored typically stored in a cookie.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthApi

public AuthApi()

AuthApi

public AuthApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

callbackCall

public okhttp3.Call callbackCall(ApiCallback _callback)
                          throws ApiException

Build call for callback

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Response that returns with set-cookie header	-
400	Email or password empty or incorrect	-

callback

public SlimUser callback()
                  throws ApiException

OpenID Connect callback OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.

Returns:

SlimUser

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Response that returns with set-cookie header	-
400	Email or password empty or incorrect	-

callbackWithHttpInfo

public ApiResponse<SlimUser> callbackWithHttpInfo()
                                           throws ApiException

OpenID Connect callback OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.

Returns:

ApiResponse<SlimUser>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Response that returns with set-cookie header	-
400	Email or password empty or incorrect	-

callbackAsync

public okhttp3.Call callbackAsync(ApiCallback<SlimUser> _callback)
                           throws ApiException

OpenID Connect callback (asynchronously) OpenID Connect callback This is the callback route for the OAuth provider, it should not be called directly. Redirects to browser with set-cookie header.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Response that returns with set-cookie header	-
400	Email or password empty or incorrect	-

getMeCall

public okhttp3.Call getMeCall(ApiCallback _callback)
                       throws ApiException

Build call for getMe

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The user corresponding to your current auth credentials	-
400	Error message indicitating you are not currently signed in	-

getMe

public SlimUser getMe()
               throws ApiException

Get Me Get Me Get the user corresponding to your current auth credentials.

Returns:

SlimUser

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The user corresponding to your current auth credentials	-
400	Error message indicitating you are not currently signed in	-

getMeWithHttpInfo

public ApiResponse<SlimUser> getMeWithHttpInfo()
                                        throws ApiException

Get Me Get Me Get the user corresponding to your current auth credentials.

Returns:

ApiResponse<SlimUser>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	The user corresponding to your current auth credentials	-
400	Error message indicitating you are not currently signed in	-

getMeAsync

public okhttp3.Call getMeAsync(ApiCallback<SlimUser> _callback)
                        throws ApiException

Get Me (asynchronously) Get Me Get the user corresponding to your current auth credentials.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	The user corresponding to your current auth credentials	-
400	Error message indicitating you are not currently signed in	-

loginCall

public okhttp3.Call loginCall(AuthQuery content,
                              ApiCallback _callback)
                       throws ApiException

Build call for login

Parameters:

content - Query parameters for login to be included as kv pairs after ? on the request URL. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
303	Response that redirects to OAuth provider through a Location header to be handled by browser.	-
400	OAuth error likely with OIDC provider.	-

login

public void login(AuthQuery content)
           throws ApiException

Login Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.

Parameters:

content - Query parameters for login to be included as kv pairs after ? on the request URL. (required)

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
303	Response that redirects to OAuth provider through a Location header to be handled by browser.	-
400	OAuth error likely with OIDC provider.	-

loginWithHttpInfo

public ApiResponse<Void> loginWithHttpInfo(@NotNull
                                           @NotNull AuthQuery content)
                                    throws ApiException

Login Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.

Parameters:

content - Query parameters for login to be included as kv pairs after ? on the request URL. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
303	Response that redirects to OAuth provider through a Location header to be handled by browser.	-
400	OAuth error likely with OIDC provider.	-

loginAsync

public okhttp3.Call loginAsync(AuthQuery content,
                               ApiCallback<Void> _callback)
                        throws ApiException

Login (asynchronously) Login This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.

Parameters:

content - Query parameters for login to be included as kv pairs after ? on the request URL. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
303	Response that redirects to OAuth provider through a Location header to be handled by browser.	-
400	OAuth error likely with OIDC provider.	-

logoutCall

public okhttp3.Call logoutCall(ApiCallback _callback)
                        throws ApiException

Build call for logout

Parameters:

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Confirmation that your current auth token has been invalidated. This does not invalidate your API key.	-

logout

public void logout()
            throws ApiException

Logout Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Confirmation that your current auth token has been invalidated. This does not invalidate your API key.	-

logoutWithHttpInfo

public ApiResponse<Void> logoutWithHttpInfo()
                                     throws ApiException

Logout Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Confirmation that your current auth token has been invalidated. This does not invalidate your API key.	-

logoutAsync

public okhttp3.Call logoutAsync(ApiCallback<Void> _callback)
                         throws ApiException

Logout (asynchronously) Logout Invalidate your current auth credential stored typically stored in a cookie. This does not invalidate your API key.

Parameters:

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Confirmation that your current auth token has been invalidated. This does not invalidate your API key.	-