List all users
GET {{baseUrl}}/users?organizationId=<string>&email=<string>&number=0&size=10&filter=<string>
Lists all users
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
organizationId | string | (Required) Specifies the ID of the organization | |
email | string | Specifies the email of the relevant user | |
number | number | Index of page to be returned. Number of available pages is returned in response body property page.totalPages. | |
size | number | Specifies the number of elements in a page. Maximum number of resources to be returned per page. The service might return less resources. | |
filter | string | JSON string allowing to filter for the following optional fields and operations. |
JSON string can contain following fields:
- id E.g.: {"id":275}
- name E.g.: {"name":"CISCO"}
- parentId E.g.: {"parentId":263}
In the following, an unencoded example filter value is shown, to return the connector instances for given asset and parameters.
{
"name":"CISCO"
}
|
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
If-None-Match | string | Specifies the ETag of the resource | |
x-user-role | string | (Required) Specifies the user role with which the user intends to perform the operation | |
Accept | string |
RESPONSES
status: OK
{"users":[{"account":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"organizationId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tenantId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"firstname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"company":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"meta":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"account":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"organizationId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"tenantId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"type":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"firstname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"lastname":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"country":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"company":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"meta":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"meta":{"page":{"totalPages":-84947498,"number":12466252,"size":-60534302,"elements":-46714189,"totalElements":-10406069}}}