Package com.confidentify.client.api

Class AuthApi

java.lang.Object

com.confidentify.client.api.AuthApi

public class AuthApi
extends Object

Constructor Summary

Constructors

Constructor	Description
AuthApi()
AuthApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuthResponse	authPost(AuthRequest authRequest)	Authenticate credentials and retrieve an access token.
okhttp3.Call	authPostAsync(AuthRequest authRequest, ApiCallback<AuthResponse> _callback)	Authenticate credentials and retrieve an access token.
okhttp3.Call	authPostCall(AuthRequest authRequest, ApiCallback _callback)	Build call for authPost
ApiResponse<AuthResponse>	authPostWithHttpInfo(AuthRequest authRequest)	Authenticate credentials and retrieve an access token.
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)

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)

authPostCall

public okhttp3.Call authPostCall(AuthRequest authRequest,
                                 ApiCallback _callback)
                          throws ApiException

Build call for authPost

Parameters:

authRequest - (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

authPost

public AuthResponse authPost(AuthRequest authRequest)
                      throws ApiException

Authenticate credentials and retrieve an access token. Consuming username/password or other credential types, this endpoint issues access tokens to be provided for the `Authorization` header of other endpoints. Access tokens are valid for 5 minutes.

Parameters:

authRequest - (required)

Returns:

AuthResponse

Throws:

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

authPostWithHttpInfo

public ApiResponse<AuthResponse> authPostWithHttpInfo(AuthRequest authRequest)
                                               throws ApiException

Authenticate credentials and retrieve an access token. Consuming username/password or other credential types, this endpoint issues access tokens to be provided for the `Authorization` header of other endpoints. Access tokens are valid for 5 minutes.

Parameters:

authRequest - (required)

Returns:

ApiResponse<AuthResponse>

Throws:

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

authPostAsync

public okhttp3.Call authPostAsync(AuthRequest authRequest,
                                  ApiCallback<AuthResponse> _callback)
                           throws ApiException

Authenticate credentials and retrieve an access token. (asynchronously) Consuming username/password or other credential types, this endpoint issues access tokens to be provided for the `Authorization` header of other endpoints. Access tokens are valid for 5 minutes.

Parameters:

authRequest - (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