Get all users matching query
GET {{baseUrl}}/v1/ws/:workspaceId/Users?q=eu&roleId=61551403&teamId=61551403&owner=true&ids=88057944&ids=-17779712&select=eu&page=61551403&size=61551403&skip=61551403&sortBy=eu&asc=true&filters=eu
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
q | string | ||
roleId | number | ||
teamId | number | ||
owner | boolean | ||
ids | number | ||
ids | number | ||
select | string | Comma separated list of fields | |
page | number | Pagination index (1 based, page 1 = 1, page 2 = 2...) | |
size | number | Size of the result page (default: 20, max 500) | |
skip | number | The number of items to skip (if not provided, it will use the default page and size prop) | |
sortBy | string | The field to sort | |
asc | boolean | True to sort ascending | |
filters | string | A serialized as json filter string using the JsonRuleEngine.net format | |
https://github.com/antoinebidault/JsonRuleEngine.Net | |||
The filters is a query param, that's why he must be properly serialized as a json string and url encoded | |||
e.g. {"field":"ProcessingType", "operator":"notEqual", "value": "Done"} | |||
The field prop must match one property name of the object (present in the output results) | |||
The operator can be equal, | |||
notEqual, | |||
lessThan, | |||
lessThanInclusive, | |||
greaterThan, | |||
greaterThanInclusive, | |||
in, | |||
notIn, | |||
contains, | |||
doesNotContains, | |||
isNull, | |||
isNotNull, | |||
isEmpty | |||
You can combine the filters as following : | |||
{ "separator":"Or","rules": [{"field":"ProcessingType", "operator":"notEqual", "value": "Done"},{"field":"ProcessingType", "operator":"isNull"}]} | |||
Serialize the filter param as following: | |||
?filters=${uriEncodeComponent(JSON.stringify({"field":"ProcessingType", "operator":"notEqual", "value": "Done"}))} |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"role":"Support","phoneNumber":"aute irure","address":"est sunt","zipCode":"esse elit","city":"Duis","countryCode":"ve","username":"laboris aliquip deserunt minim","bio":"fugiat","blogUrl":"velit minim","isInvited":true,"isOwner":false,"timeZone":"esse Ut nulla","language":"ut consequat aute","dateCreation":"2018-06-18T12:29:34.101Z","dateUpdate":"2010-02-03T10:39:20.878Z","invitations":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"workspaceId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"workspace":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"invitedUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"creatorUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"welcomeMessage":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateExpiration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateCreation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateValidation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isValidated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isExpired":{"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"},"workspaceId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"workspace":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"invitedUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"creatorUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"welcomeMessage":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateExpiration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateCreation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateValidation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isValidated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isExpired":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"loginProviders":["Duis sint deserunt","nulla exercitation ullamco"],"roles":[{"name":{"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"},"isLocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"permissions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nbUsers":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"name":{"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"},"isLocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"permissions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nbUsers":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"adminPermissions":["Tenant","ConnectAs"],"teams":[{"label":{"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"},"ref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"areas":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"users":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"label":{"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"},"ref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"areas":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"users":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"active":true,"canReceiveNotification":false,"emailVerified":false,"configuration":{"dateFormat":"Excepteur nostrud","columnsConfiguration":{"CustomerRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataTreatment":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"IncidentReport":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataProcessing":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"UserRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataBreach":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Vendor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Application":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"User":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Task":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Dashboard":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"CookieConsent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataField":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataRetentionRule":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Actor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Risk":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"AuditTemplate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"AuditResponse":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"SecurityMeasure":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubject":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ControlPoint":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskAsset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Area":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Asset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskThreat":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskEvent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"SubjectCategory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataTransfer":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubjectRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"tutorialStates":{"Startup":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Dashboard":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataProcessing":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubject":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataBreach":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"CookieWidget":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Risk":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Area":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataMapping":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"tenantOwnerId":88976371,"tenantOwner":{"name":"sed ipsum sit","id":-78082241},"ssoConfigurationId":"esse Ut laboris aute nulla","twoFactorAuthEnabled":true,"ssoGloballyEnabled":false,"id":-73648852,"displayName":"dolore magna pariat","familyName":"laborum amet","givenName":"Lorem quis occaecat","email":"ut deserunt nulla labore Duis","color":"fugiat enim ullamco","avatarUrl":"Duis quis velit do","tenantId":38738949},{"role":"Admin","phoneNumber":"nostrud amet cupidatat","address":"","zipCode":"","city":"amet mollit ipsum pariatur","countryCode":"","username":"pariatur irure tempor repreh","bio":"laborum commodo ea sunt","blogUrl":"aute anim tempor nulla magna","isInvited":false,"isOwner":true,"timeZone":"","language":"labore","dateCreation":"1974-05-18T17:55:07.582Z","dateUpdate":"1952-04-08T00:10:52.918Z","invitations":[{"id":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"workspaceId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"workspace":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"invitedUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"creatorUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"welcomeMessage":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateExpiration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateCreation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateValidation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isValidated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isExpired":{"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"},"workspaceId":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"workspace":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"invitedUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"creatorUser":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"welcomeMessage":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateExpiration":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateCreation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"dateValidation":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isValidated":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"isExpired":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"loginProviders":["qui dolore labore","aliquip dolor veniam laborum"],"roles":[{"name":{"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"},"isLocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"permissions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nbUsers":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"name":{"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"},"isLocked":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"permissions":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"nbUsers":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"adminPermissions":["Content","Content"],"teams":[{"label":{"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"},"ref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"areas":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"users":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},{"label":{"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"},"ref":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"areas":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"users":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}],"active":false,"canReceiveNotification":false,"emailVerified":false,"configuration":{"dateFormat":"fugiat Lorem labore consectetur Duis","columnsConfiguration":{"CustomerRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataTreatment":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"IncidentReport":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataProcessing":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"UserRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataBreach":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Vendor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Application":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"User":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Task":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Dashboard":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"CookieConsent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataField":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataRetentionRule":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Actor":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Risk":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"AuditTemplate":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"AuditResponse":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"SecurityMeasure":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubject":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"ControlPoint":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskAsset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Area":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Asset":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskThreat":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"RiskEvent":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"SubjectCategory":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataTransfer":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubjectRequest":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"tutorialStates":{"Startup":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Dashboard":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataProcessing":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataSubject":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataBreach":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"CookieWidget":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Risk":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"Area":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"DataMapping":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}}},"tenantOwnerId":73550730,"tenantOwner":{"name":"sint amet","id":74399389},"ssoConfigurationId":"amet do tempor","twoFactorAuthEnabled":true,"ssoGloballyEnabled":true,"id":-23223397,"displayName":"eiusmod par","familyName":"ad minim sed quis","givenName":"sit fugiat officia","email":"ut est in id non","color":"dolor dolor E","avatarUrl":"ex veniam culpa","tenantId":33131642}]