User & account

Introduction

The Eagle Eye API offers plenty of options for managing and maintaining user and account settings. But it is imperative to understand clearly the possible Eagle Eye entities and how they relate to each other.

Eagle Eye's terms:

According to the following table, account and User are two general entities that can come in various types:

Resources

There are four resources in the Eagle Eye Video API that can be possessed by the entities.

• layout
• cameras
• location
• account

GET /users endpoint

This endpoint can be used to retrieve a list of the existing users within an account. You can also specify query parameters to limit the response you will receive. Below is a list of query parameters as well as possible values for each parameter.

POST /users endpoint

By using this endpoint, you can create new users by providing information such as FirstName, LastName, and Email. To set permissions, you need to create a permission object and pass it to the endpoint. The following is a list of possible permissions and their descriptions.

/users/{userId} endpoint

You can retrieve a variety of information about an end user account by providing the user ID to this endpoint. Below is a list of possible query parameters:

• loginDetails
• locationSummary
• contactDetails
• timeZone
• support
• status
• permissions
• layoutSettings
• previewSettings
• effectivePermissions

/accounts/self

This endpoint will do the same thing as the /users/[userId] endpoint, but for accounts. Below is a list of possible query parameters:

• effectivePermissions
• timeZone
• workingHours
• security
• passwordManagementRules
• responders
• defaultCameraSettings
• videoPrivacy
• bridgeSettings
• cameraSettings
• brandingInfo

/accounts/self/capabilities

With this endpoint, you can retrieve the available features of your account. Below is a list of the different capabilities and their descriptions.

/resourceGrants endpoint

You can retrieve resources granted to entities (accounts, users) using this endpoint. According to the below resource table, you can select the "resource type" as needed.

/resourceGrants:bulkCreate and /resourceGrants:bulkDelete

It is possible to grant and revoke resources in bulk to/from multiple entities, saving integrators time and effort with multiple resource management.