How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Viridi User Controller API

The user-controller API from Viridi — 19 operation(s) for user-controller.

Viridi User Controller API is one of 56 APIs that Viridi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include user-controller. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 25 operations across 19 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 3.7.0.

Requests are made against a single base URL, https://vista.viridiparente.com.

25 operations 19 paths 14 schemas 4 DELETE14 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.7.0
Base URL
https://vista.viridiparente.com
Authentication
HTTP Loginpassword
Resource Areas
1

Authentication & Security 1

Viridi User Controller API declares 1 security scheme for authenticating requests. It uses HTTP loginpassword authentication (HTTP_login_form).

  • HTTP_login_form — Enter Username / Password

Paths & Operations 25

Across 19 paths, the API surfaces 25 operations — 4 DELETE, 14 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

user-controller 25
GET
/api/user/settings
Get user settings (getUserSettings)
getUserSettings → 200
PUT
/api/user/settings
Update user settings (saveUserSettings)
putUserSettings body → 200
POST
/api/user/settings
Save user settings (saveUserSettings)
saveUserSettings body → 200
GET
/api/user/settings/{type}
Get user settings (getUserSettings)
getUserSettings_1 1 param → 200
PUT
/api/user/settings/{type}
Update user settings (saveUserSettings)
putUserSettings_1 1 param body → 200
POST
/api/user
Save Or update User (saveUser)
saveUser 1 param body → 200
POST
/api/user/{userId}/userCredentialsEnabled
Enable/Disable User credentials (setUserCredentialsEnabled)
setUserCredentialsEnabled 2 params → 200
POST
/api/user/sendActivationMail
Send or re-send the activation email
sendActivationEmail 1 param → 200
GET
/api/user/mobile/session
Get mobile session
getMobileSession 1 param → 200
POST
/api/user/mobile/session
Save mobile session
saveMobileSession 1 param body → 200
DELETE
/api/user/mobile/session
Remove mobile session
removeMobileSession 1 param → 200
GET
/api/users
Get Users (getUsers)
getUsers 5 params → 200
GET
/api/users/info
Find users by query (findUsersByQuery)
findUsersByQuery 5 params → 200
GET
/api/users/assign/{alarmId}
Get usersForAssign (getUsersForAssign)
getUsersForAssign 6 params → 200
GET
/api/user/{userId}
Get User (getUserById)
getUserById 1 param → 200
DELETE
/api/user/{userId}
Delete User (deleteUser)
deleteUser 1 param → 200
GET
/api/user/{userId}/token
Get User Token (getUserToken)
getUserToken 1 param → 200
GET
/api/user/{userId}/activationLink
Get the activation link (getActivationLink)
getActivationLink 1 param → 200
GET
/api/user/tokenAccessEnabled
Check Token Access Enabled (isUserTokenAccessEnabled)
isUserTokenAccessEnabled → 200
GET
/api/user/dashboards
Get information about last visited and starred dashboards…
getUserDashboardsInfo → 200
GET
/api/user/dashboards/{dashboardId}/{action}
Report action of User over the dashboard (reportUserDashboardAction)
reportUserDashboardAction 2 params → 200
GET
/api/tenant/{tenantId}/users
Get Tenant Users (getTenantAdmins)
getTenantAdmins 6 params → 200
GET
/api/customer/{customerId}/users
Get Customer Users (getCustomerUsers)
getCustomerUsers 6 params → 200
DELETE
/api/user/settings/{type}/{paths}
Delete user settings (deleteUserSettings)
deleteUserSettings 2 params → 200
DELETE
/api/user/settings/{paths}
Delete user settings (deleteUserSettings)
deleteUserSettings_1 1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are User (12 properties), PageDataUserEmailInfo (4 properties), UserEmailInfo (4 properties), LastVisitedDashboardInfo (4 properties). Each schema is shown below with its type and property counts.

StarredDashboardInfo
object
3 properties
UserId
object
2 properties 2 required
JwtPair
object
JWT Pair
3 properties
UserEmailInfo
object
4 properties
JsonNode
A value representing the any type (object or primitive)
RoleId
object
2 properties 2 required
UserDashboardsInfo
object
2 properties
MobileSessionInfo
object
1 property
LastVisitedDashboardInfo
object
4 properties
User
object
A JSON value representing the User.
12 properties 2 required
PageDataUser
object
4 properties
TenantId
object
2 properties 2 required
CustomerId
object
2 properties 2 required
PageDataUserEmailInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

viridi-parente-user-controller-api-openapi.yml Raw ↑

Other APIs Viridi publishes across the network.

Viridi Admin Controller API
Viridi Alarm Comment Controller API
Viridi Alarm Controller API
Viridi Asset Controller API
Viridi Asset Profile Controller API
Viridi Audit Log Controller API
Viridi Auth Controller API
Viridi Cbrs Controller API
Viridi Component Descriptor Controller API
Viridi Customer Controller API
Viridi Dashboard Controller API
Viridi Device Connectivity Controller API
Where this information came from

This is an independent, third-party profile of Viridi User Controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.