List of users of a tenant.
GET {{baseUrl}}/Users?filter=<string>&attributes=<string>&sortBy=<string>&sortOrder=ascending&count=100&startIndex=1&subtenant=<string>
List of users of a tenant. Please note, in order to request only the list of users (without the information to which group a user belongs) it is recommended to make use of the attributes
query parameter as follows /Users?attributes=userName,name,meta (this will significantly improve the performance over simply calling /Users).
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | "SCIM filter for searching see here. The available filter attributes are: id, username, email or emails.value, givenname, familyname, active, phonenumber, verified, origin, created or meta.created, lastmodified or meta.lastmodified, version or meta.version, groups.display. | |
| </br> | |||
| <b>Note</b>: <i>groups.display</i> parameter cannot be used in complex filter expression and only <i>eq</i> operator is allowed eg. <i>filter=groups.display eq "MyGroupName"</i> | |||
attributes | string | Comma separated list of attribute names to be returned, e.g., userName, name, meta. The attributes parameters does not support the parameter "subtenants". | |
sortBy | string | Sorting field name, like email or id | |
sortOrder | string | Sort order, ascending/descending (defaults to ascending) | |
count | number | Number of objects to be returned (defaults to 100) | |
startIndex | number | The starting index of the search results when paginated. Index starts with 1 (defaults to 1). | |
subtenant | string | Filter for subtenant users |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"itemsPerPage":100,"resources":[{"schemas":["urn:scim:schemas:core:1.0","urn:scim:schemas:core:1.0"],"id":"2f95913-d3d9-4a4a-951a-c21184080cf3","userName":"johndoe@example.com","name":{"familyName":"Doe","givenName":"John"},"groups":[{"display":"mdsp:core:StandardUser","type":"DIRECT","value":"85300c9f-9616-4596-ac1c-1ca837426d7e"},{"display":"mdsp:core:StandardUser","type":"DIRECT","value":"85300c9f-9616-4596-ac1c-1ca837426d7e"}],"emails":[{"value":"johndoe@example.com"},{"value":"johndoe@example.com"}],"active":false,"meta":{"created":"2018-02-08T15:20:43.000Z","lastModified":"2018-02-08T15:20:43.000Z","version":0},"subtenants":[{"id":"octopus"},{"id":"octopus"}]},{"schemas":["urn:scim:schemas:core:1.0","urn:scim:schemas:core:1.0"],"id":"2f95913-d3d9-4a4a-951a-c21184080cf3","userName":"johndoe@example.com","name":{"familyName":"Doe","givenName":"John"},"groups":[{"display":"mdsp:core:StandardUser","type":"DIRECT","value":"85300c9f-9616-4596-ac1c-1ca837426d7e"},{"display":"mdsp:core:StandardUser","type":"DIRECT","value":"85300c9f-9616-4596-ac1c-1ca837426d7e"}],"emails":[{"value":"johndoe@example.com"},{"value":"johndoe@example.com"}],"active":true,"meta":{"created":"2018-02-08T15:20:43.000Z","lastModified":"2018-02-08T15:20:43.000Z","version":0},"subtenants":[{"id":"octopus"},{"id":"octopus"}]}],"schemas":["elit al","dolore laboris"],"startIndex":1,"totalResults":1}