Package com.launchdarkly.api.api

Class UsersApi

java.lang.Object

com.launchdarkly.api.api.UsersApi

public class UsersApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor	Description
UsersApi()
UsersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteUser(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Delete a user by ID.
com.squareup.okhttp.Call	deleteUserAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<java.lang.Void> callback)	Delete a user by ID.
com.squareup.okhttp.Call	deleteUserCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for deleteUser
ApiResponse<java.lang.Void>	deleteUserWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Delete a user by ID.
ApiClient	getApiClient()
Users	getSearchUsers(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Integer limit, java.lang.Integer offset, java.lang.Long after)	Search users in LaunchDarkly based on their last active date, or a search query.
com.squareup.okhttp.Call	getSearchUsersAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Integer limit, java.lang.Integer offset, java.lang.Long after, ApiCallback<Users> callback)	Search users in LaunchDarkly based on their last active date, or a search query.
com.squareup.okhttp.Call	getSearchUsersCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Integer limit, java.lang.Integer offset, java.lang.Long after, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getSearchUsers
ApiResponse<Users>	getSearchUsersWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Integer limit, java.lang.Integer offset, java.lang.Long after)	Search users in LaunchDarkly based on their last active date, or a search query.
UserRecord	getUser(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Get a user by key.
com.squareup.okhttp.Call	getUserAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<UserRecord> callback)	Get a user by key.
com.squareup.okhttp.Call	getUserCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getUser
Users	getUsers(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Integer limit, java.lang.String h, java.lang.String scrollId)	List all users in the environment.
com.squareup.okhttp.Call	getUsersAsync(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Integer limit, java.lang.String h, java.lang.String scrollId, ApiCallback<Users> callback)	List all users in the environment.
com.squareup.okhttp.Call	getUsersCall(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Integer limit, java.lang.String h, java.lang.String scrollId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener)	Build call for getUsers
ApiResponse<Users>	getUsersWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Integer limit, java.lang.String h, java.lang.String scrollId)	List all users in the environment.
ApiResponse<UserRecord>	getUserWithHttpInfo(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)	Get a user by key.
void	setApiClient(ApiClient apiClient)

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)

deleteUserCall

public com.squareup.okhttp.Call deleteUserCall(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               java.lang.String userKey,
                                               ProgressResponseBody.ProgressListener progressListener,
                                               ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                        throws ApiException

Build call for deleteUser

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

deleteUser

public void deleteUser(java.lang.String projectKey,
                       java.lang.String environmentKey,
                       java.lang.String userKey)
                throws ApiException

Delete a user by ID.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Throws:

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

deleteUserWithHttpInfo

public ApiResponse<java.lang.Void> deleteUserWithHttpInfo(java.lang.String projectKey,
                                                          java.lang.String environmentKey,
                                                          java.lang.String userKey)
                                                   throws ApiException

Delete a user by ID.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

ApiResponse<Void>

Throws:

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

deleteUserAsync

public com.squareup.okhttp.Call deleteUserAsync(java.lang.String projectKey,
                                                java.lang.String environmentKey,
                                                java.lang.String userKey,
                                                ApiCallback<java.lang.Void> callback)
                                         throws ApiException

Delete a user by ID. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (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

getSearchUsersCall

public com.squareup.okhttp.Call getSearchUsersCall(java.lang.String projectKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String q,
                                                   java.lang.Integer limit,
                                                   java.lang.Integer offset,
                                                   java.lang.Long after,
                                                   ProgressResponseBody.ProgressListener progressListener,
                                                   ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                            throws ApiException

Build call for getSearchUsers

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

q - Search query. (optional)

limit - Pagination limit. (optional)

offset - Specifies the first item to return in the collection. (optional)

after - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getSearchUsers

public Users getSearchUsers(java.lang.String projectKey,
                            java.lang.String environmentKey,
                            java.lang.String q,
                            java.lang.Integer limit,
                            java.lang.Integer offset,
                            java.lang.Long after)
                     throws ApiException

Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

q - Search query. (optional)

limit - Pagination limit. (optional)

offset - Specifies the first item to return in the collection. (optional)

after - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. (optional)

Returns:

Users

Throws:

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

getSearchUsersWithHttpInfo

public ApiResponse<Users> getSearchUsersWithHttpInfo(java.lang.String projectKey,
                                                     java.lang.String environmentKey,
                                                     java.lang.String q,
                                                     java.lang.Integer limit,
                                                     java.lang.Integer offset,
                                                     java.lang.Long after)
                                              throws ApiException

Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

q - Search query. (optional)

limit - Pagination limit. (optional)

offset - Specifies the first item to return in the collection. (optional)

after - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. (optional)

Returns:

ApiResponse<Users>

Throws:

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

getSearchUsersAsync

public com.squareup.okhttp.Call getSearchUsersAsync(java.lang.String projectKey,
                                                    java.lang.String environmentKey,
                                                    java.lang.String q,
                                                    java.lang.Integer limit,
                                                    java.lang.Integer offset,
                                                    java.lang.Long after,
                                                    ApiCallback<Users> callback)
                                             throws ApiException

Search users in LaunchDarkly based on their last active date, or a search query. It should not be used to enumerate all users in LaunchDarkly-- use the List users API resource. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

q - Search query. (optional)

limit - Pagination limit. (optional)

offset - Specifies the first item to return in the collection. (optional)

after - A timestamp filter, expressed as a Unix epoch time in milliseconds. All entries returned will have occurred after this timestamp. (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

getUserCall

public com.squareup.okhttp.Call getUserCall(java.lang.String projectKey,
                                            java.lang.String environmentKey,
                                            java.lang.String userKey,
                                            ProgressResponseBody.ProgressListener progressListener,
                                            ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                     throws ApiException

Build call for getUser

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUser

public UserRecord getUser(java.lang.String projectKey,
                          java.lang.String environmentKey,
                          java.lang.String userKey)
                   throws ApiException

Get a user by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

UserRecord

Throws:

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

getUserWithHttpInfo

public ApiResponse<UserRecord> getUserWithHttpInfo(java.lang.String projectKey,
                                                   java.lang.String environmentKey,
                                                   java.lang.String userKey)
                                            throws ApiException

Get a user by key.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (required)

Returns:

ApiResponse<UserRecord>

Throws:

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

getUserAsync

public com.squareup.okhttp.Call getUserAsync(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.lang.String userKey,
                                             ApiCallback<UserRecord> callback)
                                      throws ApiException

Get a user by key. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

userKey - The user's key. (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

getUsersCall

public com.squareup.okhttp.Call getUsersCall(java.lang.String projectKey,
                                             java.lang.String environmentKey,
                                             java.lang.Integer limit,
                                             java.lang.String h,
                                             java.lang.String scrollId,
                                             ProgressResponseBody.ProgressListener progressListener,
                                             ProgressRequestBody.ProgressRequestListener progressRequestListener)
                                      throws ApiException

Build call for getUsers

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

limit - Pagination limit. (optional)

h - This parameter is required when following \"next\" links. (optional)

scrollId - This parameter is required when following \"next\" links. (optional)

progressListener - Progress listener

progressRequestListener - Progress request listener

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

getUsers

public Users getUsers(java.lang.String projectKey,
                      java.lang.String environmentKey,
                      java.lang.Integer limit,
                      java.lang.String h,
                      java.lang.String scrollId)
               throws ApiException

List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

limit - Pagination limit. (optional)

h - This parameter is required when following \"next\" links. (optional)

scrollId - This parameter is required when following \"next\" links. (optional)

Returns:

Users

Throws:

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

getUsersWithHttpInfo

public ApiResponse<Users> getUsersWithHttpInfo(java.lang.String projectKey,
                                               java.lang.String environmentKey,
                                               java.lang.Integer limit,
                                               java.lang.String h,
                                               java.lang.String scrollId)
                                        throws ApiException

List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection.

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

limit - Pagination limit. (optional)

h - This parameter is required when following \"next\" links. (optional)

scrollId - This parameter is required when following \"next\" links. (optional)

Returns:

ApiResponse<Users>

Throws:

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

getUsersAsync

public com.squareup.okhttp.Call getUsersAsync(java.lang.String projectKey,
                                              java.lang.String environmentKey,
                                              java.lang.Integer limit,
                                              java.lang.String h,
                                              java.lang.String scrollId,
                                              ApiCallback<Users> callback)
                                       throws ApiException

List all users in the environment. Includes the total count of users. In each page, there will be up to 'limit' users returned (default 20). This is useful for exporting all users in the system for further analysis. Paginated collections will include a next link containing a URL with the next set of elements in the collection. (asynchronously)

Parameters:

projectKey - The project key, used to tie the flags together under one project so they can be managed together. (required)

environmentKey - The environment key, used to tie together flag configuration and users under one environment so they can be managed together. (required)

limit - Pagination limit. (optional)

h - This parameter is required when following \"next\" links. (optional)

scrollId - This parameter is required when following \"next\" links. (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