Users
GET /users
This endpoint allows the users to retrieve a list of users within the account. This endpoint supports filtering, pagination, and sorting, as well as including additional information with the response. It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available users, not the number of users resulting from the query string.
Request
- Base URLhttps://api.cxxx.eagleeyenetworks.com/api/v3.0
- URLhttps://api.cxxx.eagleeyenetworks.com/api/v3.0/users
- AuthHTTP bearer
Query parameters
includestring[]
sortstring[]
Comma separated list of of fields that should be sorted. By default, the users response is sorted by first name.
- sort= - not providing any value will result in error 400
- sort=+firstName,+firstName - same values will result in error 400
- sort=-firstName,+firstName - mutually exclusive values will return error 400
- There is no limit on the number of sort fields. All available sort fields can be combined freely, as the backend supports sorting by all of them.
- qRelevance is optional ordering parameter which is available if q filter is used, if q filter is not passed qRelevance as ordering parameter will return error 400
pageTokenstring
Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.
pageSizeinteger
The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.
id__instring[]
Filter to get the users whose id is on the provided list. The lookup is exact and case insensitive.
id__notInstring[]
Filter to exlude the users whose ids are in the provided list. The lookup is exact and case insensitive.
locationId__instring[]
List of Location IDs to filter on that is comma separated.
[ "2428fda3-389f-48ce-b062-85875dd6b2e2" ]
locationId__nestring
Example:2428fda3-389f-48ce-b062-85875dd6b2e2
Filter to get the users with an locationId that is not equal to the provided value. The lookup is exact but case insensitive.
firstName__instring[]
Filter to get the users whose firstName is on the provided list. The lookup is exact but case insensitive
firstName__containsstring
Filter to get the users whose the firstName contains the provided substring. The lookup is exact but case insensitive
lastName__instring[]
Filter to get the users whose lastName is on the provided list. The lookup is exact but case insensitive
lastName__containsstring
Filter to get the users whose the lastName contains the provided substring. The lookup is exact but case insensitive
email__containsstring
Filter to get the users whose the email contains provided substring. The lookup is exact but case insensitive
permissions.administratorboolean
Filter to get the users with provided administrator value.
status.loginStatus__instring[]
Filter to get the users whose loginStatus is on the provided list. The lookup is exact but case insensitive
qstring
Example:entrance
Text search that is applied to multiple fields. The fields being searched are defined by the backend and can be changed without warning. Example fields being searched: firstName, lastName, email.
qRelevance__gtenumber float
Example:0.5
Sets the current minimum similarity threshold that is used with the q parameter. The threshold must be between 0 and 1 (float, default is 0.5).
Parameters
#/components/parameters/email__in (unresolved $ref)
Response
OK
Example response
{
"results": [
{
"createTimestamp": "2023-04-04T09:38:37.372Z",
"locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
"loginDetails": {
"lastLogin": "2023-04-04T09:38:37.372Z"
},
"timeZone": {
"timeZone": "Americas/Chicago"
},
"support": {
"pin": "000000"
},
"schema": {
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 126,
"readOnly": true
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 126,
"readOnly": true
},
"email": {
"type": "string",
"description": "This email is used for login.",
"format": "email",
"readOnly": true
},
"locationId": {
"description": "ID Of the location.",
"minLength": 1,
"type": "string",
"nullable": true,
"example": "2428fda3-389f-48ce-b062-85875dd6b2e2",
"readOnly": false
},
"status": {
"type": "string",
"readOnly": true,
"description": "User can be enabled if set to \"active\" and disabled if set to \"blocked\"",
"enum": [
"active",
"blocked"
]
},
"loginSchedule": {
"type": "object",
"description": "It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days.\n",
"readOnly": false,
"properties": {
"sunday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
},
"monday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
},
"tuesday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
},
"wednesday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
},
"thursday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
},
"friday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
},
"saturday": {
"type": "array",
"items": {
"properties": {
"start": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day"
},
"end": {
"type": "string",
"readOnly": false,
"pattern": "^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$",
"description": "End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day"
}
}
}
}
}
},
"permissions": {
"x-jsoninclude-nonnull-annotation": true,
"type": "object",
"readOnly": true,
"properties": {
"administrator": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "All permissions are enabled - create, delete, edit, and view access to all accounts and user settings, bridges, cameras, layouts, audit log and archive.\n"
},
"editAccounts": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit Control, Days, Security, Camera, Alerts, Notifications, Privacy, Sharing, Responders, Default retentions, and camera resolution settings.\n"
},
"layoutAdministrator": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Create, delete and edit any accessible layouts. All user layouts are visible to admin users.\n"
},
"createLayouts": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Ability to create layouts and edit the layouts created. This does not grant permission to edit layouts created by other users.\n"
},
"editNoBillingDeviceSettings": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit Camera Settings except for Cloud Retention and Full Video Resolution. Cannot add or delete cameras. Edit existing Analytics. Cannot add or delete Analytics.\n"
},
"turnCamerasOnOff": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Turn Cameras on/off. Cameras off cannot be recorded."
},
"editMotionAreas": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit Motion Settings. Set object size and sensitivity, add/delete regions, add/delete alerts for regions. Edit existing Analytics. Set object size and sensitivity, add/delete alerts.\n"
},
"editAllCameraSettings": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Editing all Camera Settings. Cannot add or delete cameras."
},
"editUsers": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Create, delete and edit non-admin users in an end user account."
},
"upgradeEdition": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Upgrade current edition subscription to a higher level edition."
},
"addEditBridgesCameras": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Create, delete, edit, and view Bridges and Cameras. This is the only permission for a non-admin to be able to add and view bridges in an end user account.\n"
},
"editSharing": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit Sharing and Responders settings."
},
"controlPTZ": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Control Pan, Tilt, Zoom, & recall stations while viewing a preview or live video of PTZ cameras.\n"
},
"editPTZStations": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit PTZ Settings. Set PTZ mode and create, delete, edit stations.\n"
},
"addEditSpeakers": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Add speakers, edit speaker settings, delete speakers."
},
"editSpeakers": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit speaker settings. Cannot add or delete speakers."
},
"viewLiveVideo": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View full resolution video live."
},
"viewHistoricVideo": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View history browser and historic video."
},
"downloadVideo": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Download preview and full resolution video."
},
"viewPreviewVideo": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View preview images from cameras."
},
"talkDown": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Allows the users to initiate Talk Down to the camera field(s) of view."
},
"editMap": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Add and edit floors, lines, shapes, and cameras on the map."
},
"viewAuditLog": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View Audit Log and download reports from it."
},
"viewArchive": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View all files and folders within the Archive."
},
"editArchive": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Save videos to Archive - delete, edit, and view files and folders within the Archive."
},
"viewPlugins": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View all Plugins."
},
"editPlugins": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Add and remove plugins."
},
"exportUsers": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Export a list of account users in .csv format."
},
"viewVSP": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "User access to view vehicle data, search vehicle across camera & location, set rules, and alert."
},
"editResellerUsers": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Create, delete and edit reseller user who is not an Admin."
},
"editAdminUsers": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Create, delete and edit admin and non-admin users in an end user account. Give access to bridges, cameras, and layouts. Create new end user accounts and give access to them.\n"
},
"viewContract": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View recordings, search, and create new recordings."
},
"addRemovePayment": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Add and remove payment methods."
},
"viewInvoice": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View and download invoices."
},
"placeOrders": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Add products to the shopping cart and place orders."
},
"viewShipments": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View the status of shipments."
},
"viewPricingInformation": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View pricing information."
},
"viewResellerProgramInformation": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View Marketing's reseller program information."
},
"viewVSPRule": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View VSP rules."
},
"editVSPRule": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit VSP rules."
},
"viewVehicleList": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View vehicle lists."
},
"editVehicleList": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit vehicle lists."
},
"viewAutomations": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View automation alerts, rules, and actions."
},
"editAutomations": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit automation alerts, rules, and actions."
},
"editAlertManagerRulesAndActions": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "Edit Automations rules and actions."
},
"viewAlertManagerRulesAndActions": {
"type": "boolean",
"readOnly": true,
"x-jsoninclude-nonnull-annotation": true,
"description": "View Alert Manager rules and actions."
}
}
},
"employeeId": {
"nullable": true,
"type": "string",
"description": "Custom text field",
"maxLength": 50,
"readOnly": false
}
}
},
"qRelevance": 0.5
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.