This provides a list of users in the system
Example
aiware getAdminUsers X-Correlation-Id:value offset=value limit=value orderBy=value direction=value status=value name=value userName=value email=value roleIDs=value organizationIDs=value accessAllOrganization=value isSuperAdmin=value
Parameters
| Name | Type | Description | Notes |
|---|
| xCorrelationId | string | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | [optional] [default to null] |
| offset | integer | the number of users to skip before getting the result set | [optional] [default to null] |
| limit | integer | the number of users to return. | [optional] [default to 100] |
| orderBy | string | the field to sort | [optional] [default to created_date_time] |
| direction | string | the sort order | [optional] [default to DESC] |
| status | string | the value should be in [active, trial, inactive, deleted] | [optional] [default to null] |
| name | string | Name of user | [optional] [default to null] |
| userName | string | userName of user | [optional] [default to null] |
| email | string | email of user | [optional] [default to null] |
| roleIDs | string | Filters by role | [optional] [default to null] |
| organizationIDs | string | Filters by internal organization ID | [optional] [default to null] |
| accessAllOrganization | boolean | A user can access to all organization or not. | [optional] [default to null] |
| isSuperAdmin | boolean | | [optional] [default to null] |
Return type
AdminUsersGetResponse
Authorization
api_key
- Content-Type: Not Applicable
- Accept: application/json
