Java API endpoint: getAdminUsers

AdminUsersGetResponse getAdminUsers(xCorrelationId, offset, limit, orderBy, direction, status, name, userName, email, roleIDs, organizationIDs, accessAllOrganization, isSuperAdmin)

This provides a list of users in the system.

Example

// Import classes:
import com.veritone.aiware.ApiClient;
import com.veritone.aiware.ApiException;
import com.veritone.aiware.Configuration;
import com.veritone.aiware.auth.*;
import com.veritone.aiware.models.*;
import com.veritone.aiware.edge.AdminApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.aiware.com/edge/v1");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    AdminApi apiInstance = new AdminApi(defaultClient);
    String xCorrelationId = "xCorrelationId_example"; // String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request
    Integer offset = 56; // Integer | the number of users to skip before getting the result set
    Integer limit = 100; // Integer | the number of users to return.
    String orderBy = "\"created_date_time\""; // String | the field to sort
    String direction = "\"DESC\""; // String | the sort order
    String status = "status_example"; // String | the value should be in [active, trial, inactive, deleted]
    String name = "name_example"; // String | Name of user
    String userName = "userName_example"; // String | userName of user
    String email = "email_example"; // String | email of user
    UUID roleIDs = new UUID(); // UUID | Filters by role
    UUID organizationIDs = new UUID(); // UUID | Filters by internal organization ID
    Boolean accessAllOrganization = true; // Boolean | A user can access to all organization or not.
    Boolean isSuperAdmin = true; // Boolean | 
    try {
      AdminUsersGetResponse result = apiInstance.getAdminUsers(xCorrelationId, offset, limit, orderBy, direction, status, name, userName, email, roleIDs, organizationIDs, accessAllOrganization, isSuperAdmin);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminApi#getAdminUsers");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Return type

AdminUsersGetResponse

Authorization

api_key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

• AI Processing API and clients
• Java API client for AI Processing
• AdminAPI
• getAdminUsers