List all external users
GET {{baseUrl}}/external-users?organizationId=<string>&userId=<string>&number=0&size=10&filter=<string>&sort=<string>
List all external users
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
organizationId | string | (Required) Specifies the ID of the organization | |
userId | string | Specifies the ID 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"
}
|
| sort | string | | Specifies the fields to sort the results by.
Ex: GET /resources?sort=-color,+name : Sorts the results based on descending color order and ascending name order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
If-None-Match | string | Specifies the ETag of the resource | |
Accept | string |
RESPONSES
status: OK
{"externalUsers":[{"id":"a1b2c3d4","organizationId":"a1b2c3d4","organizationName":"Carrots Inc","referredUser":{"userId":{"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"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"status":"ADMITTED","referredAt":"2021-08-25T08:55:18.687Z","referrerUser":{"userId":{"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"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"reviewerUser":{"userId":{"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"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"referrerComment":"A technician for robot arms","reviewerComment":"We no longer require the user in our organization","reviewedAt":"2021-08-25T08:55:18.687Z","meta":{"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},{"id":"a1b2c3d4","organizationId":"a1b2c3d4","organizationName":"Carrots Inc","referredUser":{"userId":{"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"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"status":"ADMITTED","referredAt":"2021-08-25T08:55:18.687Z","referrerUser":{"userId":{"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"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"reviewerUser":{"userId":{"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"},"email":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"referrerComment":"A technician for robot arms","reviewerComment":"We no longer require the user in our organization","reviewedAt":"2021-08-25T08:55:18.687Z","meta":{"version":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}}],"meta":{"page":{"totalPages":63075464,"number":84100660,"size":28291043,"elements":-58846699,"totalElements":85925252}}}