com.adaptris.permissions.security.access.auth.api

Class UsersApi

java.lang.Object

com.adaptris.permissions.security.access.auth.api.UsersApi

public class UsersApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	changePassword(java.lang.String old, java.lang.String _new) Changes the password of current user
com.squareup.okhttp.Call	changePasswordAsync(java.lang.String old, java.lang.String _new, ApiCallback<java.lang.Void> callback) Changes the password of current user (asynchronously)
ApiResponse<java.lang.Void>	changePasswordWithHttpInfo(java.lang.String old, java.lang.String _new) Changes the password of current user
UserData	create(UserData body) Creates user
com.squareup.okhttp.Call	createAsync(UserData body, ApiCallback<UserData> callback) Creates user (asynchronously)
ApiResponse<UserData>	createWithHttpInfo(UserData body) Creates user
UserData	current() Returns access-token user
com.squareup.okhttp.Call	currentAsync(ApiCallback<UserData> callback) Returns access-token user (asynchronously)
ApiResponse<UserData>	currentWithHttpInfo() Returns access-token user
UserData	get_0(java.lang.String id) Gets user by id
com.squareup.okhttp.Call	get_0Async(java.lang.String id, ApiCallback<UserData> callback) Gets user by id (asynchronously)
ApiResponse<UserData>	get_0WithHttpInfo(java.lang.String id) Gets user by id
PagedUserData	get(java.lang.Integer limit, java.lang.String firstName, java.lang.String lastName, java.lang.String email) Gets all users which maybe taken by current user
ApiClient	getApiClient()
com.squareup.okhttp.Call	getAsync(java.lang.Integer limit, java.lang.String firstName, java.lang.String lastName, java.lang.String email, ApiCallback<PagedUserData> callback) Gets all users which maybe taken by current user (asynchronously)
ApiResponse<PagedUserData>	getWithHttpInfo(java.lang.Integer limit, java.lang.String firstName, java.lang.String lastName, java.lang.String email) Gets all users which maybe taken by current user
void	remove(java.lang.String id) Deletes a user
com.squareup.okhttp.Call	removeAsync(java.lang.String id, ApiCallback<java.lang.Void> callback) Deletes a user (asynchronously)
ApiResponse<java.lang.Void>	removeWithHttpInfo(java.lang.String id) Deletes a user
void	setApiClient(ApiClient apiClient)
UserData	update(java.lang.String id, UserData body) Updates user
com.squareup.okhttp.Call	updateAsync(java.lang.String id, UserData body, ApiCallback<UserData> callback) Updates user (asynchronously)
ApiResponse<UserData>	updateWithHttpInfo(java.lang.String id, UserData body) Updates user

Methods inherited from class java.lang.Object

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

Constructor Detail

UsersApi

public UsersApi()

UsersApi

public UsersApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

changePassword

public void changePassword(java.lang.String old,
                           java.lang.String _new)
                    throws ApiException

Changes the password of current user

Parameters:

old - (optional)

_new - (optional)

Throws:

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

changePasswordWithHttpInfo

public ApiResponse<java.lang.Void> changePasswordWithHttpInfo(java.lang.String old,
                                                              java.lang.String _new)
                                                       throws ApiException

Changes the password of current user

Parameters:

old - (optional)

_new - (optional)

Returns:

ApiResponse<Void>

Throws:

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

changePasswordAsync

public com.squareup.okhttp.Call changePasswordAsync(java.lang.String old,
                                                    java.lang.String _new,
                                                    ApiCallback<java.lang.Void> callback)
                                             throws ApiException

Changes the password of current user (asynchronously)

Parameters:

old - (optional)

_new - (optional)

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

create

public UserData create(UserData body)
                throws ApiException

Creates user

Parameters:

body - (optional)

Returns:

UserData

Throws:

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

createWithHttpInfo

public ApiResponse<UserData> createWithHttpInfo(UserData body)
                                         throws ApiException

Creates user

Parameters:

body - (optional)

Returns:

ApiResponse<UserData>

Throws:

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

createAsync

public com.squareup.okhttp.Call createAsync(UserData body,
                                            ApiCallback<UserData> callback)
                                     throws ApiException

Creates user (asynchronously)

Parameters:

body - (optional)

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

current

public UserData current()
                 throws ApiException

Returns access-token user

Returns:

UserData

Throws:

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

currentWithHttpInfo

public ApiResponse<UserData> currentWithHttpInfo()
                                          throws ApiException

Returns access-token user

Returns:

ApiResponse<UserData>

Throws:

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

currentAsync

public com.squareup.okhttp.Call currentAsync(ApiCallback<UserData> callback)
                                      throws ApiException

Returns access-token user (asynchronously)

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

get

public PagedUserData get(java.lang.Integer limit,
                         java.lang.String firstName,
                         java.lang.String lastName,
                         java.lang.String email)
                  throws ApiException

Gets all users which maybe taken by current user

Parameters:

limit - Limit of search response (optional, default to 100)

firstName - Search by first name (optional)

lastName - Search by last name (optional)

email - Search by email (optional)

Returns:

PagedUserData

Throws:

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

getWithHttpInfo

public ApiResponse<PagedUserData> getWithHttpInfo(java.lang.Integer limit,
                                                  java.lang.String firstName,
                                                  java.lang.String lastName,
                                                  java.lang.String email)
                                           throws ApiException

Gets all users which maybe taken by current user

Parameters:

limit - Limit of search response (optional, default to 100)

firstName - Search by first name (optional)

lastName - Search by last name (optional)

email - Search by email (optional)

Returns:

ApiResponse<PagedUserData>

Throws:

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

getAsync

public com.squareup.okhttp.Call getAsync(java.lang.Integer limit,
                                         java.lang.String firstName,
                                         java.lang.String lastName,
                                         java.lang.String email,
                                         ApiCallback<PagedUserData> callback)
                                  throws ApiException

Gets all users which maybe taken by current user (asynchronously)

Parameters:

limit - Limit of search response (optional, default to 100)

firstName - Search by first name (optional)

lastName - Search by last name (optional)

email - Search by email (optional)

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

get_0

public UserData get_0(java.lang.String id)
               throws ApiException

Gets user by id

Parameters:

id - (required)

Returns:

UserData

Throws:

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

get_0WithHttpInfo

public ApiResponse<UserData> get_0WithHttpInfo(java.lang.String id)
                                        throws ApiException

Gets user by id

Parameters:

id - (required)

Returns:

ApiResponse<UserData>

Throws:

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

get_0Async

public com.squareup.okhttp.Call get_0Async(java.lang.String id,
                                           ApiCallback<UserData> callback)
                                    throws ApiException

Gets user by id (asynchronously)

Parameters:

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

remove

public void remove(java.lang.String id)
            throws ApiException

Deletes a user

Parameters:

id - (required)

Throws:

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

removeWithHttpInfo

public ApiResponse<java.lang.Void> removeWithHttpInfo(java.lang.String id)
                                               throws ApiException

Deletes a user

Parameters:

id - (required)

Returns:

ApiResponse<Void>

Throws:

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

removeAsync

public com.squareup.okhttp.Call removeAsync(java.lang.String id,
                                            ApiCallback<java.lang.Void> callback)
                                     throws ApiException

Deletes a user (asynchronously)

Parameters:

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

update

public UserData update(java.lang.String id,
                       UserData body)
                throws ApiException

Updates user

Parameters:

id - (required)

body - (optional)

Returns:

UserData

Throws:

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

updateWithHttpInfo

public ApiResponse<UserData> updateWithHttpInfo(java.lang.String id,
                                                UserData body)
                                         throws ApiException

Updates user

Parameters:

id - (required)

body - (optional)

Returns:

ApiResponse<UserData>

Throws:

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

updateAsync

public com.squareup.okhttp.Call updateAsync(java.lang.String id,
                                            UserData body,
                                            ApiCallback<UserData> callback)
                                     throws ApiException

Updates user (asynchronously)

Parameters:

id - (required)

body - (optional)

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