Api

Class UserManagementApi

java.lang.Object

Api.UserManagementApi

public class UserManagementApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserManagementApi()
UserManagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
UmsV1UsersGet200Response	getUsers(String organizationId, String userName, String permissionId, String roleId) Get User Information - Deprecated This endpoint is deprecated.
okhttp3.Call	getUsersAsync(String organizationId, String userName, String permissionId, String roleId, ApiCallback<UmsV1UsersGet200Response> callback) Get User Information - Deprecated (asynchronously) This endpoint is deprecated.
okhttp3.Call	getUsersCall(String organizationId, String userName, String permissionId, String roleId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) Build call for getUsers
ApiResponse<UmsV1UsersGet200Response>	getUsersWithHttpInfo(String organizationId, String userName, String permissionId, String roleId) Get User Information - Deprecated This endpoint is deprecated.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagementApi

public UserManagementApi()

UserManagementApi

public UserManagementApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getUsersCall

public okhttp3.Call getUsersCall(String organizationId,
                                 String userName,
                                 String permissionId,
                                 String roleId,
                                 ProgressResponseBody.ProgressListener progressListener,
                                 ProgressRequestBody.ProgressRequestListener progressRequestListener)
                          throws ApiException

Build call for getUsers

Parameters:

organizationId - This is the orgId of the organization which the user belongs to. (optional)

userName - User ID of the user you want to get details on. (optional)

permissionId - permission that you are trying to search user on. (optional)

roleId - role of the user you are trying to search on. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUsers

public UmsV1UsersGet200Response getUsers(String organizationId,
                                         String userName,
                                         String permissionId,
                                         String roleId)
                                  throws ApiException

Get User Information - Deprecated This endpoint is deprecated. Please use the search end point.

Parameters:

organizationId - This is the orgId of the organization which the user belongs to. (optional)

userName - User ID of the user you want to get details on. (optional)

permissionId - permission that you are trying to search user on. (optional)

roleId - role of the user you are trying to search on. (optional)

Returns:

UmsV1UsersGet200Response

Throws:

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

getUsersWithHttpInfo

public ApiResponse<UmsV1UsersGet200Response> getUsersWithHttpInfo(String organizationId,
                                                                  String userName,
                                                                  String permissionId,
                                                                  String roleId)
                                                           throws ApiException

Get User Information - Deprecated This endpoint is deprecated. Please use the search end point.

Parameters:

organizationId - This is the orgId of the organization which the user belongs to. (optional)

userName - User ID of the user you want to get details on. (optional)

permissionId - permission that you are trying to search user on. (optional)

roleId - role of the user you are trying to search on. (optional)

Returns:

ApiResponse<UmsV1UsersGet200Response>

Throws:

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

getUsersAsync

public okhttp3.Call getUsersAsync(String organizationId,
                                  String userName,
                                  String permissionId,
                                  String roleId,
                                  ApiCallback<UmsV1UsersGet200Response> callback)
                           throws ApiException

Get User Information - Deprecated (asynchronously) This endpoint is deprecated. Please use the search end point.

Parameters:

organizationId - This is the orgId of the organization which the user belongs to. (optional)

userName - User ID of the user you want to get details on. (optional)

permissionId - permission that you are trying to search user on. (optional)

roleId - role of the user you are trying to search on. (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