EdgeCore version: 4.3.0
Method
GET /public/domains/{domainName}/users
Used to retrieve all users belonging to a specific domain.
Parameters
| Name | Type | Description | Mandatory |
domainName |
string | Domain | Yes |
index |
integer | Paging index; Default is 0; | No |
count |
integer | Results per page; Default is 50; | No |
search |
string | Username search string | No |
cURL example
curl --location --request GET 'http://localhost:8080/public/domains/default/users?index=0&count=3' \ --header 'edgeApiKey: YWRtaW5AZGVmYXVsdHx3IDNHe2tMZTYhMkZkO3J3cipDaSZUdio5'
Example Response
[
{
"apiKey": null,
"doClass": "AccountUserDO",
"id": "s3pvsu-k636f3lq68qu",
"userName": "admin",
"attributes": {
"FirstName": "edgeCore"
},
"domainName": "default",
"domainId": "s3pvsu-k636f3lq68qr",
"accountUserMeta": {
"doClass": "AccountUserMetaDO",
"creationTime": 0,
"currentLogin": 1606475641894,
"failures": 0,
"lastChange": 0,
"lastAdminReset": 0,
"changedByAdmin": false,
"lastFailure": 0,
"lastLogin": 1606475260446,
"temporaryLock": false,
"permanentLock": false,
"lockTime": 0,
"lockReason": null,
"acceptedFormNames": []
},
"kioskMode": null
},
{
"apiKey": null,
"doClass": "AccountUserDO",
"id": "s3pvsu-k636f3lq69pe",
"userName": "alex",
"attributes": {},
"domainName": "default",
"domainId": "s3pvsu-k636f3lq68qr",
"accountUserMeta": {
"doClass": "AccountUserMetaDO",
"creationTime": 1606475696370,
"currentLogin": 0,
"failures": 0,
"lastChange": 1606475696370,
"lastAdminReset": 1606477747750,
"changedByAdmin": true,
"lastFailure": 0,
"lastLogin": 0,
"temporaryLock": false,
"permanentLock": false,
"lockTime": 0,
"lockReason": null,
"acceptedFormNames": []
},
"kioskMode": null
},
{
"apiKey": null,
"doClass": "AccountUserDO",
"id": "s3pvsu-k636f3lq69pg",
"userName": "jane",
"attributes": {},
"domainName": "default",
"domainId": "s3pvsu-k636f3lq68qr",
"accountUserMeta": {
"doClass": "AccountUserMetaDO",
"creationTime": 1606475717124,
"currentLogin": 0,
"failures": 0,
"lastChange": 1606475717124,
"lastAdminReset": 1606477747751,
"changedByAdmin": true,
"lastFailure": 0,
"lastLogin": 0,
"temporaryLock": false,
"permanentLock": false,
"lockTime": 0,
"lockReason": null,
"acceptedFormNames": []
},
"kioskMode": null
}
]
HTTP Response
| Code | Status | Description |
| 200 | OK | The request has succeeded.
Additionally, if the domain does not have any users, [] will be returned. |
| 404 | Not Found | The domain could not be found. |