---
title: "GET /users/self"
method: GET
path: "/users/self"
tags: ["Users"]
---

# GET /users/self

`GET /users/self`

This endpoint allows the users to retrieve info about the current user.

## Query parameters

- `include` string[]

## Response `200`

OK

- ApiUserForSelf
  - `id` string, required
  - `createTimestamp` string, date-time
  - `firstName` string, required
  - `lastName` string, required
  - `email` string, email, required — This email is used for login.
  - `accountId` string, required
  - `locationId` string, nullable — ID Of the location.
  - `language` string, required
  - `employeeId` string, nullable, required — Custom text field
  - `status` Status — This status signifies the current status of the user.
    - `loginStatus` 'active' | 'pending' | 'blocked' — Login status of user * `active` - User is active * `pending` - Every newly created user is in pending state until it verifies its email and set credentials. * `blocked` - User was active once but it has been disabled by Admin.
    - `managedBy` 'scim' | 'bss' | 'local' — Indicates which system manages this user account. This determines whether the user is managed externally or directly within the Eagle Eye Networks Video Management System (VMS). This value affects what operations are allowed through the API for this user. Specifically, the `effectivePermissions` and `schema` objects should be used to determine what actions are permitted in the current session. Possible values: * `scim` – The user is managed by an external identity provider using SCIM. * `bss` – The user is managed by Brivo Security Suite. * `local` – The user is managed directly through the Eagle Eye Networks API and user interfaces.
  - `locationSummary` LocationSummary — Summary of location information.
    - `id` string
    - `name` string
    - `address` object
      - `country` string, nullable
      - `region` string, nullable
      - `city` string, nullable
      - `streetAddress` string, nullable
      - `streetAddress2` string, nullable
      - `postalCode` string, nullable
  - `loginDetails` LoginDetails
    - `lastLogin` string, date-time
    - `loginSchedule` WeeklyIntervalSchedule — 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.
      - `sunday` Interval[]
        - `start` string, required — 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` string, required — 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` Interval[]
        - `start` string, required — 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` string, required — 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` Interval[]
        - `start` string, required — 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` string, required — 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` Interval[]
        - `start` string, required — 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` string, required — 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` Interval[]
        - `start` string, required — 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` string, required — 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` Interval[]
        - `start` string, required — 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` string, required — 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` Interval[]
        - `start` string, required — 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` string, required — 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
  - `timeZone` TimeZone — Represents a time zone that is supported by the Eagle Eye Networks API. Designed as an object to allow future extension by adding new fields.
    - `name` string — Name of the time zone in "tz database" format of "Area/Location" us as identifier of the time zone in the EEN API.
  - `contactDetails` ContactDetails
    - `alternateEmail` string, email — This email is used sending notifications from user account.
    - `phone` string
  - `support` Support
    - `pin` string — Six digit string that signifies a support pin. Support can use this pin to login to user account.
  - `permissions` Permissions
    - `administrator` boolean — All permissions are enabled - create, delete, edit, and view access to all accounts and user settings, bridges, cameras, layouts, audit log and archive.
    - `editAccounts` boolean — Edit Control, Days, Security, Camera, Alerts, Notifications, Privacy, Sharing, Responders, Default retentions, and camera resolution settings.
    - `layoutAdministrator` boolean — Create, delete and edit any accessible layouts. All user layouts are visible to admin users.
    - `createLayouts` boolean — Ability to create layouts and edit the layouts created. This does not grant permission to edit layouts created by other users.
    - `editNoBillingDeviceSettings` boolean — Edit Camera Settings except for Cloud Retention and Full Video Resolution. Cannot add or delete cameras. Edit existing Analytics. Cannot add or delete Analytics.
    - `turnCamerasOnOff` boolean — Turn Cameras on/off. Cameras off cannot be recorded.
    - `editMotionAreas` boolean — 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.
    - `editAllCameraSettings` boolean — Editing all Camera Settings. Cannot add or delete cameras.
    - `editUsers` boolean — Create, delete and edit non-admin users in an end user account.
    - `upgradeEdition` boolean — Upgrade current edition subscription to a higher level edition.
    - `addEditBridgesCameras` boolean — 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.
    - `editSharing` boolean — Edit Sharing and Responders settings.
    - `controlPTZ` boolean — Control Pan, Tilt, Zoom, & recall stations while viewing a preview or live video of PTZ cameras.
    - `editPTZStations` boolean — Edit PTZ Settings. Set PTZ mode and create, delete, edit stations.
    - `addEditSpeakers` boolean — Add speakers, edit speaker settings, delete speakers.
    - `editSpeakers` boolean — Edit speaker settings. Cannot add or delete speakers.
    - `viewLiveVideo` boolean — View full resolution video live.
    - `viewHistoricVideo` boolean — View history browser and historic video.
    - `downloadVideo` boolean — Download preview and full resolution video.
    - `viewPreviewVideo` boolean — View preview images from cameras.
    - `talkDown` boolean — Allows the users to initiate Talk Down to the camera field(s) of view.
    - `editMap` boolean — Add and edit floors, lines, shapes, and cameras on the map.
    - `viewAuditLog` boolean — View Audit Log and download reports from it.
    - `viewArchive` boolean — View all files and folders within the Archive.
    - `editArchive` boolean — Save videos to Archive - delete, edit, and view files and folders within the Archive.
    - `viewPlugins` boolean — View all Plugins.
    - `editPlugins` boolean — Add and remove plugins.
    - `exportUsers` boolean — Export a list of account users in .csv format.
    - `viewVSP` boolean — User access to view vehicle data, search vehicle across camera & location, set rules, and alert.
    - `editResellerUsers` boolean — Create, delete and edit reseller user who is not an Admin.
    - `editAdminUsers` boolean — 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.
    - `viewContract` boolean — View recordings, search, and create new recordings.
    - `addRemovePayment` boolean — Add and remove payment methods.
    - `viewInvoice` boolean — View and download invoices.
    - `placeOrders` boolean — Add products to the shopping cart and place orders.
    - `viewShipments` boolean — View the status of shipments.
    - `viewPricingInformation` boolean — View pricing information.
    - `viewResellerProgramInformation` boolean — View Marketing's reseller program information.
    - `viewVSPRule` boolean — View VSP rules.
    - `editVSPRule` boolean — Edit VSP rules.
    - `viewVehicleList` boolean — View vehicle lists.
    - `editVehicleList` boolean — Edit vehicle lists.
    - `viewAutomations` boolean — View automation alerts, rules, and actions.
    - `editAutomations` boolean — Edit automation alerts, rules, and actions.
    - `editAlertManagerRulesAndActions` boolean — Edit Automations rules and actions.
    - `viewAlertManagerRulesAndActions` boolean — View Alert Manager rules and actions.
  - `layoutSettings` LayoutSettings
    - `rotationInterval` integer, required — Layout rotation internal in seconds after which current layout is switched to next one in the below list.
    - `rotationOrder` string[], required — Ordered list of layout IDs that user has access to, which will be displayed in order after rotationInterval. This array may contain deleted layouts or those to which the user lost access. They need to be filtered out on the client side.
  - `previewSettings` PreviewSettings
    - `showMotionBoxes` boolean — Indicates whether motion boxes should be shown
    - `showAnalytics` boolean — Indicates whether additional analytics should be shown
    - `showPluginExtensions` boolean — Indicates whether to show custom annotations for third party applications.
  - `effectivePermissions` EffectiveUserPermissions
    - `read` boolean
    - `delete` boolean
    - `edit` boolean
    - `resourceGrants` boolean — Indicates whether the current session has permission to grant or revoke resources (such as devices, locations, and accounts) for the specified user.
    - `roleAssignments` boolean — Indicates whether the current session has permission to assign roles to the specified user.
  - `timeSettings` TimeSettings
    - `showMilliseconds` boolean — Select to display milliseconds when playing video.
    - `format` '24h' | '12h' — Select between 12 and 24 hour mode for the display of time.
  - `schema` UserSchema — Optional "include" that returns a JSON Schema Draft 4 object describing this resource. Enables clients to determine allowed interactions dynamically (e.g., whether a field can be updated), even if the general OpenAPI spec permits more. Useful for context-specific capability enforcement.
  - `identityId` string, uuid, nullable — The unique identifier of the user's identity in the system.

## Other responses

- `400` — The supplied object is invalid. Error detail will contain the validation error.
- `401` — You are not authenticated. Please authenticate and try again.
- `403` — You have no permission to access the specified resource.
- `404` — Referenced resource could not be found.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)