public class UserAdministrationApi
extends java.lang.Object
| Constructor and Description |
|---|
UserAdministrationApi() |
UserAdministrationApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
void |
changeUserPassword(java.lang.Integer userId,
Password password)
Change Password
Local users' passwords may be changed by administrators.
|
com.squareup.okhttp.Call |
changeUserPasswordAsync(java.lang.Integer userId,
Password password,
ApiCallback<java.lang.Void> callback)
Change Password (asynchronously)
Local users' passwords may be changed by administrators.
|
com.squareup.okhttp.Call |
changeUserPasswordCall(java.lang.Integer userId,
Password password,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for changeUserPassword
|
ApiResponse<java.lang.Void> |
changeUserPasswordWithHttpInfo(java.lang.Integer userId,
Password password)
Change Password
Local users' passwords may be changed by administrators.
|
User |
createExternalUser(CreateUser user)
Create External User
Creates an External user.
|
com.squareup.okhttp.Call |
createExternalUserAsync(CreateUser user,
ApiCallback<User> callback)
Create External User (asynchronously)
Creates an External user.
|
com.squareup.okhttp.Call |
createExternalUserCall(CreateUser user,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createExternalUser
|
ApiResponse<User> |
createExternalUserWithHttpInfo(CreateUser user)
Create External User
Creates an External user.
|
User |
createKeyUser(CreateUser user)
Create API Key User
Creates a API key user
|
com.squareup.okhttp.Call |
createKeyUserAsync(CreateUser user,
ApiCallback<User> callback)
Create API Key User (asynchronously)
Creates a API key user
|
com.squareup.okhttp.Call |
createKeyUserCall(CreateUser user,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createKeyUser
|
ApiResponse<User> |
createKeyUserWithHttpInfo(CreateUser user)
Create API Key User
Creates a API key user
|
User |
createLdapUser(CreateUser user)
Create LDAP User
Creates a LDAP user.
|
com.squareup.okhttp.Call |
createLdapUserAsync(CreateUser user,
ApiCallback<User> callback)
Create LDAP User (asynchronously)
Creates a LDAP user.
|
com.squareup.okhttp.Call |
createLdapUserCall(CreateUser user,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createLdapUser
|
ApiResponse<User> |
createLdapUserWithHttpInfo(CreateUser user)
Create LDAP User
Creates a LDAP user.
|
User |
createLocalUser(CreateUser user)
Create Local User
Creates a local user.
|
com.squareup.okhttp.Call |
createLocalUserAsync(CreateUser user,
ApiCallback<User> callback)
Create Local User (asynchronously)
Creates a local user.
|
com.squareup.okhttp.Call |
createLocalUserCall(CreateUser user,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for createLocalUser
|
ApiResponse<User> |
createLocalUserWithHttpInfo(CreateUser user)
Create Local User
Creates a local user.
|
void |
deleteUser(java.lang.Integer userId)
Delete User
To delete a user, you must know its id (found from its corresponding user object).
|
com.squareup.okhttp.Call |
deleteUserAsync(java.lang.Integer userId,
ApiCallback<java.lang.Void> callback)
Delete User (asynchronously)
To delete a user, you must know its id (found from its corresponding user object).
|
com.squareup.okhttp.Call |
deleteUserCall(java.lang.Integer userId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteUser
|
ApiResponse<java.lang.Void> |
deleteUserWithHttpInfo(java.lang.Integer userId)
Delete User
To delete a user, you must know its id (found from its corresponding user object).
|
java.util.List<User> |
getAllUsers()
List All Users
Returns a list of all users.
|
com.squareup.okhttp.Call |
getAllUsersAsync(ApiCallback<java.util.List<User>> callback)
List All Users (asynchronously)
Returns a list of all users.
|
com.squareup.okhttp.Call |
getAllUsersCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getAllUsers
|
ApiResponse<java.util.List<User>> |
getAllUsersWithHttpInfo()
List All Users
Returns a list of all users.
|
ApiClient |
getApiClient() |
java.util.List<User> |
getExternalUsers()
List External Users
Returns a list of external users.
|
com.squareup.okhttp.Call |
getExternalUsersAsync(ApiCallback<java.util.List<User>> callback)
List External Users (asynchronously)
Returns a list of external users.
|
com.squareup.okhttp.Call |
getExternalUsersCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getExternalUsers
|
ApiResponse<java.util.List<User>> |
getExternalUsersWithHttpInfo()
List External Users
Returns a list of external users.
|
java.util.List<User> |
getKeyUsers()
List API Key Users
Returns a list of API key users.
|
com.squareup.okhttp.Call |
getKeyUsersAsync(ApiCallback<java.util.List<User>> callback)
List API Key Users (asynchronously)
Returns a list of API key users.
|
com.squareup.okhttp.Call |
getKeyUsersCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getKeyUsers
|
ApiResponse<java.util.List<User>> |
getKeyUsersWithHttpInfo()
List API Key Users
Returns a list of API key users.
|
java.util.List<User> |
getLdapUsers()
List LDAP Users
Returns a list of LDAP users.
|
com.squareup.okhttp.Call |
getLdapUsersAsync(ApiCallback<java.util.List<User>> callback)
List LDAP Users (asynchronously)
Returns a list of LDAP users.
|
com.squareup.okhttp.Call |
getLdapUsersCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getLdapUsers
|
ApiResponse<java.util.List<User>> |
getLdapUsersWithHttpInfo()
List LDAP Users
Returns a list of LDAP users.
|
java.util.List<User> |
getLocalUsers()
List Local Users
Returns a list of local users.
|
com.squareup.okhttp.Call |
getLocalUsersAsync(ApiCallback<java.util.List<User>> callback)
List Local Users (asynchronously)
Returns a list of local users.
|
com.squareup.okhttp.Call |
getLocalUsersCall(ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getLocalUsers
|
ApiResponse<java.util.List<User>> |
getLocalUsersWithHttpInfo()
List Local Users
Returns a list of local users.
|
User |
modifyUser(java.lang.Integer userId,
DisableUser disableUser)
Disable User or Add/Remove Admin
A single endpoint is shared by the \"enable/disable user\" and \"add/remove admin role\" functionality.
|
com.squareup.okhttp.Call |
modifyUserAsync(java.lang.Integer userId,
DisableUser disableUser,
ApiCallback<User> callback)
Disable User or Add/Remove Admin (asynchronously)
A single endpoint is shared by the \"enable/disable user\" and \"add/remove admin role\" functionality.
|
com.squareup.okhttp.Call |
modifyUserCall(java.lang.Integer userId,
DisableUser disableUser,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for modifyUser
|
ApiResponse<User> |
modifyUserWithHttpInfo(java.lang.Integer userId,
DisableUser disableUser)
Disable User or Add/Remove Admin
A single endpoint is shared by the \"enable/disable user\" and \"add/remove admin role\" functionality.
|
User |
regenerateApiKey(java.lang.Integer userId)
Regenerate API Key
API Keys are represented with the key user type.
|
com.squareup.okhttp.Call |
regenerateApiKeyAsync(java.lang.Integer userId,
ApiCallback<User> callback)
Regenerate API Key (asynchronously)
API Keys are represented with the key user type.
|
com.squareup.okhttp.Call |
regenerateApiKeyCall(java.lang.Integer userId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for regenerateApiKey
|
ApiResponse<User> |
regenerateApiKeyWithHttpInfo(java.lang.Integer userId)
Regenerate API Key
API Keys are represented with the key user type.
|
void |
setApiClient(ApiClient apiClient) |
public UserAdministrationApi()
public UserAdministrationApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public com.squareup.okhttp.Call changeUserPasswordCall(java.lang.Integer userId,
Password password,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
throws ApiException
userId - The user ID. (required)password - (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void changeUserPassword(java.lang.Integer userId,
Password password)
throws ApiException
userId - The user ID. (required)password - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.lang.Void> changeUserPasswordWithHttpInfo(java.lang.Integer userId, Password password) throws ApiException
userId - The user ID. (required)password - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call changeUserPasswordAsync(java.lang.Integer userId,
Password password,
ApiCallback<java.lang.Void> callback)
throws ApiException
userId - The user ID. (required)password - (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call createExternalUserCall(CreateUser user, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
user - (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic User createExternalUser(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<User> createExternalUserWithHttpInfo(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call createExternalUserAsync(CreateUser user, ApiCallback<User> callback) throws ApiException
user - (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call createKeyUserCall(CreateUser user, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
user - (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic User createKeyUser(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<User> createKeyUserWithHttpInfo(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call createKeyUserAsync(CreateUser user, ApiCallback<User> callback) throws ApiException
user - (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call createLdapUserCall(CreateUser user, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
user - (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic User createLdapUser(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<User> createLdapUserWithHttpInfo(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call createLdapUserAsync(CreateUser user, ApiCallback<User> callback) throws ApiException
user - (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call createLocalUserCall(CreateUser user, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
user - (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic User createLocalUser(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<User> createLocalUserWithHttpInfo(CreateUser user) throws ApiException
user - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call createLocalUserAsync(CreateUser user, ApiCallback<User> callback) throws ApiException
user - (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call deleteUserCall(java.lang.Integer userId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
throws ApiException
userId - The user ID. (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void deleteUser(java.lang.Integer userId)
throws ApiException
userId - The user ID. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.lang.Void> deleteUserWithHttpInfo(java.lang.Integer userId) throws ApiException
userId - The user ID. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call deleteUserAsync(java.lang.Integer userId,
ApiCallback<java.lang.Void> callback)
throws ApiException
userId - The user ID. (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getAllUsersCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic java.util.List<User> getAllUsers() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.util.List<User>> getAllUsersWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getAllUsersAsync(ApiCallback<java.util.List<User>> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getExternalUsersCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic java.util.List<User> getExternalUsers() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.util.List<User>> getExternalUsersWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getExternalUsersAsync(ApiCallback<java.util.List<User>> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getKeyUsersCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic java.util.List<User> getKeyUsers() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.util.List<User>> getKeyUsersWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getKeyUsersAsync(ApiCallback<java.util.List<User>> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getLdapUsersCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic java.util.List<User> getLdapUsers() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.util.List<User>> getLdapUsersWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getLdapUsersAsync(ApiCallback<java.util.List<User>> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call getLocalUsersCall(ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic java.util.List<User> getLocalUsers() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<java.util.List<User>> getLocalUsersWithHttpInfo() throws ApiException
ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call getLocalUsersAsync(ApiCallback<java.util.List<User>> callback) throws ApiException
callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call modifyUserCall(java.lang.Integer userId,
DisableUser disableUser,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
throws ApiException
userId - The user ID. (required)disableUser - (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic User modifyUser(java.lang.Integer userId, DisableUser disableUser) throws ApiException
userId - The user ID. (required)disableUser - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<User> modifyUserWithHttpInfo(java.lang.Integer userId, DisableUser disableUser) throws ApiException
userId - The user ID. (required)disableUser - (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call modifyUserAsync(java.lang.Integer userId,
DisableUser disableUser,
ApiCallback<User> callback)
throws ApiException
userId - The user ID. (required)disableUser - (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic com.squareup.okhttp.Call regenerateApiKeyCall(java.lang.Integer userId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
throws ApiException
userId - The user ID. (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic User regenerateApiKey(java.lang.Integer userId) throws ApiException
userId - The user ID. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<User> regenerateApiKeyWithHttpInfo(java.lang.Integer userId) throws ApiException
userId - The user ID. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic com.squareup.okhttp.Call regenerateApiKeyAsync(java.lang.Integer userId,
ApiCallback<User> callback)
throws ApiException
userId - The user ID. (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object