Package com.seeq.api

Class UsersApi

java.lang.Object
com.seeq.api.UsersApi

public class UsersApi extends Object
  • Constructor Details

    • UsersApi

      public UsersApi()
    • UsersApi

      public UsersApi(ApiClient apiClient)
  • Method Details

    • setRetryTimeout

      public void setRetryTimeout(long retryTimeout)
    • getRetryTimeout

      public long getRetryTimeout()
    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • autocompleteUsersAndGroups

      public IdentityPreviewListV1 autocompleteUsersAndGroups(Integer offset, Integer limit, String query) throws ApiException
      Parameters:
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      query - Part of user or group name to search for (required)
      Returns:
      IdentityPreviewListV1
      Throws:
      ApiException - if fails to make API call
    • autocompleteUsersAndGroupsWithHttpInfo

      public ApiClient.ApiResponse<IdentityPreviewListV1> autocompleteUsersAndGroupsWithHttpInfo(Integer offset, Integer limit, String query) throws ApiException
      Parameters:
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      query - Part of user or group name to search for (required)
      Throws:
      ApiException - if fails to make API call
    • autocompleteUsersAndGroupsWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<IdentityPreviewListV1> autocompleteUsersAndGroupsWithHeadersAndHttpInfo(Integer offset, Integer limit, String query, Map<String,String> customHeaders) throws ApiException
      Parameters:
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      query - Part of user or group name to search for (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • createUser

      public UserOutputV1 createUser(UserInputV1 body) throws ApiException
      Create a user
      Parameters:
      body - User information (required)
      Returns:
      UserOutputV1
      Throws:
      ApiException - if fails to make API call
    • createUserWithHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> createUserWithHttpInfo(UserInputV1 body) throws ApiException
      Create a user
      Parameters:
      body - User information (required)
      Throws:
      ApiException - if fails to make API call
    • createUserWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> createUserWithHeadersAndHttpInfo(UserInputV1 body, Map<String,String> customHeaders) throws ApiException
      Create a user
      Parameters:
      body - User information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • deleteUser

      public StatusMessageBase deleteUser(String id, String newOwnerId, Boolean transferAclAndGroupMembership) throws ApiException
      Delete a user
      Parameters:
      id - ID of the user to delete (required)
      newOwnerId - ID of the user to take over ownership of items. If not specified and the user to delete has owned items, a '400 Bad Request' will be returned. (optional)
      transferAclAndGroupMembership - True if any ACL entries and group memberships for the user being deleted should be transferred to the new owner, false if ACL entries should be deleted and group memberships shouldn't be transferred. When migrating users to a different authentication method, this should be set to true. When actually deleting a user, it should usually be set to false. The default is 'false'. (optional, default to false)
      Returns:
      StatusMessageBase
      Throws:
      ApiException - if fails to make API call
    • deleteUserWithHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deleteUserWithHttpInfo(String id, String newOwnerId, Boolean transferAclAndGroupMembership) throws ApiException
      Delete a user
      Parameters:
      id - ID of the user to delete (required)
      newOwnerId - ID of the user to take over ownership of items. If not specified and the user to delete has owned items, a '400 Bad Request' will be returned. (optional)
      transferAclAndGroupMembership - True if any ACL entries and group memberships for the user being deleted should be transferred to the new owner, false if ACL entries should be deleted and group memberships shouldn't be transferred. When migrating users to a different authentication method, this should be set to true. When actually deleting a user, it should usually be set to false. The default is 'false'. (optional, default to false)
      Throws:
      ApiException - if fails to make API call
    • deleteUserWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<StatusMessageBase> deleteUserWithHeadersAndHttpInfo(String id, String newOwnerId, Boolean transferAclAndGroupMembership, Map<String,String> customHeaders) throws ApiException
      Delete a user
      Parameters:
      id - ID of the user to delete (required)
      newOwnerId - ID of the user to take over ownership of items. If not specified and the user to delete has owned items, a '400 Bad Request' will be returned. (optional)
      transferAclAndGroupMembership - True if any ACL entries and group memberships for the user being deleted should be transferred to the new owner, false if ACL entries should be deleted and group memberships shouldn't be transferred. When migrating users to a different authentication method, this should be set to true. When actually deleting a user, it should usually be set to false. The default is 'false'. (optional, default to false)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getMe

      public UserOutputV1 getMe() throws ApiException
      Get the user that belongs to this authentication session
      Returns:
      UserOutputV1
      Throws:
      ApiException - if fails to make API call
    • getMeWithHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> getMeWithHttpInfo() throws ApiException
      Get the user that belongs to this authentication session
      Throws:
      ApiException - if fails to make API call
    • getMeWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> getMeWithHeadersAndHttpInfo(Map<String,String> customHeaders) throws ApiException
      Get the user that belongs to this authentication session
      Parameters:
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getUser

      public UserOutputV1 getUser(String id) throws ApiException
      Get a user
      Parameters:
      id - ID of the user to retrieve (required)
      Returns:
      UserOutputV1
      Throws:
      ApiException - if fails to make API call
    • getUserWithHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> getUserWithHttpInfo(String id) throws ApiException
      Get a user
      Parameters:
      id - ID of the user to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getUserWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> getUserWithHeadersAndHttpInfo(String id, Map<String,String> customHeaders) throws ApiException
      Get a user
      Parameters:
      id - ID of the user to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getUserFromUsername

      public UserOutputV1 getUserFromUsername(String authDatasourceClass, String authDatasourceId, String username) throws ApiException
      Search for user from a username
      Parameters:
      authDatasourceClass - Auth datasource class of the user to retrieve (required)
      authDatasourceId - Auth datasource id of the user to retrieve (required)
      username - Username of the user to retrieve (required)
      Returns:
      UserOutputV1
      Throws:
      ApiException - if fails to make API call
    • getUserFromUsernameWithHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> getUserFromUsernameWithHttpInfo(String authDatasourceClass, String authDatasourceId, String username) throws ApiException
      Search for user from a username
      Parameters:
      authDatasourceClass - Auth datasource class of the user to retrieve (required)
      authDatasourceId - Auth datasource id of the user to retrieve (required)
      username - Username of the user to retrieve (required)
      Throws:
      ApiException - if fails to make API call
    • getUserFromUsernameWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> getUserFromUsernameWithHeadersAndHttpInfo(String authDatasourceClass, String authDatasourceId, String username, Map<String,String> customHeaders) throws ApiException
      Search for user from a username
      Parameters:
      authDatasourceClass - Auth datasource class of the user to retrieve (required)
      authDatasourceId - Auth datasource id of the user to retrieve (required)
      username - Username of the user to retrieve (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • getUsers

      public UserOutputListV1 getUsers(String usernameSearch, String emailSearch, String firstNameSearch, String lastNameSearch, String datasourceNameSearch, Boolean isAdmin, Boolean isEnabled, Boolean isLoggedIn, Boolean isCreated, String sortOrder, Integer offset, Integer limit) throws ApiException
      Get a collection of users
      Parameters:
      usernameSearch - Search text by which to filter users' names. (optional)
      emailSearch - Search text by which to filter users' email addresses. (optional)
      firstNameSearch - Search text by which to filter users' first names. (optional)
      lastNameSearch - Search text by which to filter users' last names. (optional)
      datasourceNameSearch - Search text by which to filter users' directories. (optional)
      isAdmin - Whether to filter users to only users who are administrators. (optional)
      isEnabled - Whether to filter users to only users who are enabled. (optional)
      isLoggedIn - Whether to filter users to only users who are logged in. (optional)
      isCreated - Whether to filter to users that did not come pre-installed with Seeq. (optional)
      sortOrder - A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, directory (optional, default to email asc)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      Returns:
      UserOutputListV1
      Throws:
      ApiException - if fails to make API call
    • getUsersWithHttpInfo

      public ApiClient.ApiResponse<UserOutputListV1> getUsersWithHttpInfo(String usernameSearch, String emailSearch, String firstNameSearch, String lastNameSearch, String datasourceNameSearch, Boolean isAdmin, Boolean isEnabled, Boolean isLoggedIn, Boolean isCreated, String sortOrder, Integer offset, Integer limit) throws ApiException
      Get a collection of users
      Parameters:
      usernameSearch - Search text by which to filter users' names. (optional)
      emailSearch - Search text by which to filter users' email addresses. (optional)
      firstNameSearch - Search text by which to filter users' first names. (optional)
      lastNameSearch - Search text by which to filter users' last names. (optional)
      datasourceNameSearch - Search text by which to filter users' directories. (optional)
      isAdmin - Whether to filter users to only users who are administrators. (optional)
      isEnabled - Whether to filter users to only users who are enabled. (optional)
      isLoggedIn - Whether to filter users to only users who are logged in. (optional)
      isCreated - Whether to filter to users that did not come pre-installed with Seeq. (optional)
      sortOrder - A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, directory (optional, default to email asc)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      Throws:
      ApiException - if fails to make API call
    • getUsersWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputListV1> getUsersWithHeadersAndHttpInfo(String usernameSearch, String emailSearch, String firstNameSearch, String lastNameSearch, String datasourceNameSearch, Boolean isAdmin, Boolean isEnabled, Boolean isLoggedIn, Boolean isCreated, String sortOrder, Integer offset, Integer limit, Map<String,String> customHeaders) throws ApiException
      Get a collection of users
      Parameters:
      usernameSearch - Search text by which to filter users' names. (optional)
      emailSearch - Search text by which to filter users' email addresses. (optional)
      firstNameSearch - Search text by which to filter users' first names. (optional)
      lastNameSearch - Search text by which to filter users' last names. (optional)
      datasourceNameSearch - Search text by which to filter users' directories. (optional)
      isAdmin - Whether to filter users to only users who are administrators. (optional)
      isEnabled - Whether to filter users to only users who are enabled. (optional)
      isLoggedIn - Whether to filter users to only users who are logged in. (optional)
      isCreated - Whether to filter to users that did not come pre-installed with Seeq. (optional)
      sortOrder - A field by which to order the users followed by a space and 'asc' or 'desc'. Field name can be one of: username, email, firstName, lastName, directory (optional, default to email asc)
      offset - The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)
      limit - The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updatePassword

      public UserOutputV1 updatePassword(String id, UserPasswordInputV1 body) throws ApiException
      Update password for a user authenticating through Seeq
      Parameters:
      id - ID of the user to set password for (required)
      body - User information (required)
      Returns:
      UserOutputV1
      Throws:
      ApiException - if fails to make API call
    • updatePasswordWithHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> updatePasswordWithHttpInfo(String id, UserPasswordInputV1 body) throws ApiException
      Update password for a user authenticating through Seeq
      Parameters:
      id - ID of the user to set password for (required)
      body - User information (required)
      Throws:
      ApiException - if fails to make API call
    • updatePasswordWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> updatePasswordWithHeadersAndHttpInfo(String id, UserPasswordInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update password for a user authenticating through Seeq
      Parameters:
      id - ID of the user to set password for (required)
      body - User information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call
    • updateUser

      public UserOutputV1 updateUser(String id, UserInputV1 body) throws ApiException
      Update a user
      Parameters:
      id - ID of the user to update (required)
      body - User Update information (required)
      Returns:
      UserOutputV1
      Throws:
      ApiException - if fails to make API call
    • updateUserWithHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> updateUserWithHttpInfo(String id, UserInputV1 body) throws ApiException
      Update a user
      Parameters:
      id - ID of the user to update (required)
      body - User Update information (required)
      Throws:
      ApiException - if fails to make API call
    • updateUserWithHeadersAndHttpInfo

      public ApiClient.ApiResponse<UserOutputV1> updateUserWithHeadersAndHttpInfo(String id, UserInputV1 body, Map<String,String> customHeaders) throws ApiException
      Update a user
      Parameters:
      id - ID of the user to update (required)
      body - User Update information (required)
      customHeaders - a map with custom headers for the HTTP request (required)
      Throws:
      ApiException - if fails to make API call