Skip to content
/Users

Users

Endpoints for managing users including creation, authentication, permissions, and user account management

Operations

Return all users for current user account.

Request

GET /v2/users
Security
API_Key
Query
withDeletedboolean

Include deleted users

Default:false
GET
/users
curl -i -X GET \
  'https://api.observepoint.com/v2/users?withDeleted=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
Array [
accountIdinteger, (int32)required
createdstring, (date-time)required
deletedstring

ISO 8601 date time string with offset when user was deleted, null if not deleted

emailstringrequired
firstNamestringrequired
fullUsageDashboardAccessbooleanrequired
idinteger, (int32)required
lastLoginstring, (date-time)
lastNamestringrequired
maxPagesPerAuditinteger, (int32)required
permissionsstring
Enum:"guest""user""admin"
timezonestringrequired
updatedstring, (date-time)required
usernamestringrequired
]
Response
[
  {
    "accountId": 0,
    "created": "2019-08-24T14:15:22Z",
    "deleted": "string",
    "email": "string",
    "firstName": "string",
    "fullUsageDashboardAccess": true,
    "id": 0,
    "lastLogin": "2019-08-24T14:15:22Z",
    "lastName": "string",
    "maxPagesPerAudit": 0,
    "permissions": "guest",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "username": "string"
  }
]