Package com.launchdarkly.api.api

Class UsersApi

  • public class UsersApi
extends java.lang.Object

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deleteUser​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)
      Delete user Delete a user by key.
      okhttp3.Call deleteUserAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<java.lang.Void> _callback)
      Delete user (asynchronously) Delete a user by key.
      okhttp3.Call deleteUserCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback _callback)
      Build call for deleteUser
      ApiResponse<java.lang.Void> deleteUserWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)
      Delete user Delete a user by key.
      ApiClient getApiClient()  
      java.lang.String getCustomBaseUrl()  
      int getHostIndex()  
      Users getSearchUsers​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Long limit, java.lang.Long offset, java.lang.Long after, java.lang.String sort, java.lang.String searchAfter, java.lang.String filter)
      Find users Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query.
      okhttp3.Call getSearchUsersAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Long limit, java.lang.Long offset, java.lang.Long after, java.lang.String sort, java.lang.String searchAfter, java.lang.String filter, ApiCallback<Users> _callback)
      Find users (asynchronously) Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query.
      okhttp3.Call getSearchUsersCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Long limit, java.lang.Long offset, java.lang.Long after, java.lang.String sort, java.lang.String searchAfter, java.lang.String filter, ApiCallback _callback)
      Build call for getSearchUsers
      ApiResponse<Users> getSearchUsersWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String q, java.lang.Long limit, java.lang.Long offset, java.lang.Long after, java.lang.String sort, java.lang.String searchAfter, java.lang.String filter)
      Find users Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query.
      UserRecord getUser​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)
      Get user Get a user by key.
      okhttp3.Call getUserAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback<UserRecord> _callback)
      Get user (asynchronously) Get a user by key.
      okhttp3.Call getUserCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey, ApiCallback _callback)
      Build call for getUser
      UsersRep getUsers​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long limit, java.lang.String searchAfter)
      List users List all users in the environment.
      okhttp3.Call getUsersAsync​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long limit, java.lang.String searchAfter, ApiCallback<UsersRep> _callback)
      List users (asynchronously) List all users in the environment.
      okhttp3.Call getUsersCall​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long limit, java.lang.String searchAfter, ApiCallback _callback)
      Build call for getUsers
      ApiResponse<UsersRep> getUsersWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.Long limit, java.lang.String searchAfter)
      List users List all users in the environment.
      ApiResponse<UserRecord> getUserWithHttpInfo​(java.lang.String projectKey, java.lang.String environmentKey, java.lang.String userKey)
      Get user Get a user by key.
      void setApiClient​(ApiClient apiClient)  
      void setCustomBaseUrl​(java.lang.String customBaseUrl)  
      void setHostIndex​(int hostIndex)  

      • 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)

      • getHostIndex

        public int getHostIndex()

      • setHostIndex

        public void setHostIndex​(int hostIndex)

      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()

      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)

      • deleteUserCall

        public okhttp3.Call deleteUserCall​(java.lang.String projectKey,
                                   java.lang.String environmentKey,
                                   java.lang.String userKey,
                                   ApiCallback _callback)
                            throws ApiException
        Build call for deleteUser
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user key (required)
        _callback - Callback for upload/download progress
        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 user Delete a user by key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user 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 user Delete a user by key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user 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 okhttp3.Call deleteUserAsync​(java.lang.String projectKey,
                                    java.lang.String environmentKey,
                                    java.lang.String userKey,
                                    ApiCallback<java.lang.Void> _callback)
                             throws ApiException
        Delete user (asynchronously) Delete a user by key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user 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 okhttp3.Call getSearchUsersCall​(java.lang.String projectKey,
                                       java.lang.String environmentKey,
                                       java.lang.String q,
                                       java.lang.Long limit,
                                       java.lang.Long offset,
                                       java.lang.Long after,
                                       java.lang.String sort,
                                       java.lang.String searchAfter,
                                       java.lang.String filter,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getSearchUsers
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        q - Full-text search for users based on name, first name, last name, e-mail address, or key (optional)
        limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)
        offset - Specifies the first item to return in the collection (optional)
        after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly (optional)
        sort - Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        filter - A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue (optional)
        _callback - Callback for upload/download progress
        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.Long limit,
                            java.lang.Long offset,
                            java.lang.Long after,
                            java.lang.String sort,
                            java.lang.String searchAfter,
                            java.lang.String filter)
                     throws ApiException
        Find users Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](/#section/Representations). > ### `offset` is deprecated > > `offset` is deprecated and will be removed in a future API version. You can still use `offset` and `limit` for pagination, but we recommend you use `sort` and `searchAfter` instead. `searchAfter` allows you to page through more than 10,000 users, but `offset` and `limit` do not.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        q - Full-text search for users based on name, first name, last name, e-mail address, or key (optional)
        limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)
        offset - Specifies the first item to return in the collection (optional)
        after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly (optional)
        sort - Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        filter - A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue (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.Long limit,
                                                     java.lang.Long offset,
                                                     java.lang.Long after,
                                                     java.lang.String sort,
                                                     java.lang.String searchAfter,
                                                     java.lang.String filter)
                                              throws ApiException
        Find users Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](/#section/Representations). > ### `offset` is deprecated > > `offset` is deprecated and will be removed in a future API version. You can still use `offset` and `limit` for pagination, but we recommend you use `sort` and `searchAfter` instead. `searchAfter` allows you to page through more than 10,000 users, but `offset` and `limit` do not.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        q - Full-text search for users based on name, first name, last name, e-mail address, or key (optional)
        limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)
        offset - Specifies the first item to return in the collection (optional)
        after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly (optional)
        sort - Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        filter - A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue (optional)
        Returns:
        ApiResponse<Users>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getSearchUsersAsync

        public okhttp3.Call getSearchUsersAsync​(java.lang.String projectKey,
                                        java.lang.String environmentKey,
                                        java.lang.String q,
                                        java.lang.Long limit,
                                        java.lang.Long offset,
                                        java.lang.Long after,
                                        java.lang.String sort,
                                        java.lang.String searchAfter,
                                        java.lang.String filter,
                                        ApiCallback<Users> _callback)
                                 throws ApiException
        Find users (asynchronously) Search users in LaunchDarkly based on their last active date, a user attribute filter set, or a search query. An example user attribute filter set is `filter=firstName:Anna,activeTrial:false`. This matches users that have the user attribute `firstName` set to `Anna`, that also have the attribute `activeTrial` set to `false`. To paginate through results, follow the `next` link in the `_links` object. To learn more, read [Representations](/#section/Representations). > ### `offset` is deprecated > > `offset` is deprecated and will be removed in a future API version. You can still use `offset` and `limit` for pagination, but we recommend you use `sort` and `searchAfter` instead. `searchAfter` allows you to page through more than 10,000 users, but `offset` and `limit` do not.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        q - Full-text search for users based on name, first name, last name, e-mail address, or key (optional)
        limit - Specifies the maximum number of items in the collection to return (max: 50, default: 20) (optional)
        offset - Specifies the first item to return in the collection (optional)
        after - A unix epoch time in milliseconds specifying the maximum last time a user requested a feature flag from LaunchDarkly (optional)
        sort - Specifies a field by which to sort. LaunchDarkly supports the `userKey` and `lastSeen` fields. Fields prefixed by a dash ( - ) sort in descending order. (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        filter - A comma-separated list of user attribute filters. Each filter is in the form of attributeKey:attributeValue (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 okhttp3.Call getUserCall​(java.lang.String projectKey,
                                java.lang.String environmentKey,
                                java.lang.String userKey,
                                ApiCallback _callback)
                         throws ApiException
        Build call for getUser
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user key (required)
        _callback - Callback for upload/download progress
        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 user Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user 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 user Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user 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 okhttp3.Call getUserAsync​(java.lang.String projectKey,
                                 java.lang.String environmentKey,
                                 java.lang.String userKey,
                                 ApiCallback<UserRecord> _callback)
                          throws ApiException
        Get user (asynchronously) Get a user by key. The `user` object contains all attributes sent in `variation` calls for that key.
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        userKey - The user 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 okhttp3.Call getUsersCall​(java.lang.String projectKey,
                                 java.lang.String environmentKey,
                                 java.lang.Long limit,
                                 java.lang.String searchAfter,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for getUsers
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The number of elements to return per page (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getUsers

        public UsersRep getUsers​(java.lang.String projectKey,
                         java.lang.String environmentKey,
                         java.lang.Long limit,
                         java.lang.String searchAfter)
                  throws ApiException
        List users List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](/#section/Representations).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The number of elements to return per page (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        Returns:
        UsersRep
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUsersWithHttpInfo

        public ApiResponse<UsersRep> getUsersWithHttpInfo​(java.lang.String projectKey,
                                                  java.lang.String environmentKey,
                                                  java.lang.Long limit,
                                                  java.lang.String searchAfter)
                                           throws ApiException
        List users List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](/#section/Representations).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The number of elements to return per page (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (optional)
        Returns:
        ApiResponse<UsersRep>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getUsersAsync

        public okhttp3.Call getUsersAsync​(java.lang.String projectKey,
                                  java.lang.String environmentKey,
                                  java.lang.Long limit,
                                  java.lang.String searchAfter,
                                  ApiCallback<UsersRep> _callback)
                           throws ApiException
        List users (asynchronously) List all users in the environment. Includes the total count of users. This is useful for exporting all users in the system for further analysis. Each page displays users up to a set `limit`. The default is 20. To page through, follow the `next` link in the `_links` object. To learn more, read [Representations](/#section/Representations).
        Parameters:
        projectKey - The project key (required)
        environmentKey - The environment key (required)
        limit - The number of elements to return per page (optional)
        searchAfter - Limits results to users with sort values after the value you specify. You can use this for pagination, but we recommend using the `next` link we provide instead. (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