api-admin.hnpw.asmira.video
Open in
urlscan Pro
3.77.161.147
Public Scan
Submitted URL: https://api-admin.hnpw.asmira.video/
Effective URL: https://api-admin.hnpw.asmira.video/docs/v1/
Submission: On May 02 via api from US — Scanned from DE
Effective URL: https://api-admin.hnpw.asmira.video/docs/v1/
Submission: On May 02 via api from US — Scanned from DE
Form analysis 1 forms found in the DOM
<form class="download-url-wrapper"><input class="download-url-input" type="text" value=""><button class="download-url-button button">Explore</button></form>Text Content
Explore
ASMIRA CONFIGURATION API
1.0.0
OAS3
The ASMIRA Configuration API allows an Admin or a Sysadmin to manage users and
rooms on the ASMIRA Server.
Authorize
APPLICATIONS
AN APPLICATION IS AN ASMIRA HEADLESS SENDER WITH PROPERTIES: NAME, VERSION, URL,
COPYRIGHT ETC. AN APPLICATION WILL ALWAYS BELONG TO A USER. A USER MAY HAVE 0 OR
MORE APPLICATIONS. EACH APPLICATION HAS CONFIGURATIONS AND STATUSES ASSOCIATED
WITH IT.
GET/v1/applications
List all applications. Returns all applications for Admin, or else the
applications accessible to the logged in user.
POST/v1/applications
Create an application. Allowed only for Admin.
PUT/v1/applications/{id}
Update an application. Allowed to update any user if Admin, or else only the
applications accessible to the logged in user.
GET/v1/applications/{id}
Get an application. Allowed to get any application if Admin, or else the
applications accessible to the logged in user.
DELETE/v1/applications/{id}
Delete an application. Allowed only for Admin.
AUTH
SIGNING IN WITH YOUR CREDENTIALS WILL ALLLOW YOU REQUEST RESOURCES REQUIRING
AUTHENTICATION AND AUTHORIZATION.
POST/v1/auth/signin
Sign in getting jwtAccessToken, jwtRefreshToken and user
POST/v1/auth/signinWithJwtAccessToken
Sign with jwtAccessToken in getting jwtAccessToken, jwtRefreshToken and user
POST/v1/auth/refreshJwt
Refresh JWT Tokens
POST/v1/auth/verifyJwt
Verify JWT Tokens
COMMANDS
RESTARTING THE ASMIRA SERVER IS ALLOWED USING A COMMAND CURRENTLY AVAILABLE AS
/RESTART, BUT THIS REQUIRES SYSADMIN PRIVILEGES.
GET/v1/commands
List all commands. Allowed only for SysAdmin
POST/v1/commands/restart
Create a restart command. Allowed only for SysAdmin.
CONFIGS
A CONFIG IS ALWAYS ATTACHED TO AN APPLICATION. THIS COULD BE
CLIP_RECORDER_BITRATE, SENSOR_ENABLED, OBJECT_DETECTION_WEIGHT_MIN ETC. AN
APPLICATION MAY HAVE MANY CONFIGS AND EACH CONFIG WILL BELONG TO ONLY ONE
APPLICATION.
GET/v1/configs
List all configs. Returns all configs for Admin, or else the configs accessible
to the logged in user.
POST/v1/configs
Create a config. Allowed to create any config for Admin, or else the
applicationId assigned to the config must be accessible to the logged in user.
PUT/v1/configs/{id}
Update a config. Allowed to update any config for Admin, or else the
applicationId assigned to the config and the config it self must be accessible
to the logged in user.
GET/v1/configs/{id}
Get a config. Allowed to get any config if Admin, or else the configs accessible
to the logged in user.
DELETE/v1/configs/{id}
Delete a config. Allowed to delete any config for Admin, or else the config must
be accessible to the logged in user.
CONNECTIONS
A CONNECTION CAN BE CREATED TO ALLOW THE SERVER TO TRACK USER CONNECTION. A
CONNECTION WILL EXPIRE UNLESS IT IS EXTENDED USING THE EXTEND API. THERE IS A
RUNNING CLEANUP PROCESS THAT WILL REMOVE EXPIRED CONNECTIONS.
GET/v1/connections
List all connections. Returns all connections if logged in user is Admin or
SysAdmin, or else the connections for the logged in user.
POST/v1/connections
Create a connection belonging to your logged in user.
DELETE/v1/connections/{id}
Delete a connection belonging to your logged in user.
PUT/v1/connections/{id}/extend
Extend the expiry of a connection belonging to your logged in user.
ROOMS
ONLY AN ADMIN IS ALLOWED TO CREATE OR CHANGE ROOMS. ROOMS CAN ONLY BE CREATED
WHILE THE CURRENT NUMBER OF ROOMS IS LESS THAN THE LICENCED ROOMS FOUND IN THE
SETTING ENDPOINT.
GET/v1/rooms
List all rooms. All users are allowed to get any room.
POST/v1/rooms
Create a room. Allowed only for Admin.
PUT/v1/rooms/{id}
Update a room. Allowed only for Admin.
GET/v1/rooms/{id}
Get a room. All users are allowed to get any room.
DELETE/v1/rooms/{id}
Delete a Room. Allowed only for Admin.
SETTINGS
SETTINGS CONTAIN SERVER SETTINGS LIKE MAX_ROOMS AND LICENCED_ROOMS AND MAY ONLY
BE CREATED/UPDATED/DELETED BY SYSADMINS.
PUT/v1/settings/
Create/Update one or more settings. Allowed only for Sysadmin. Creates a new
key-value if the key does not exist, or else updates the existing key with the
value
GET/v1/settings/
Get settings. Allowed to get settings only for Admin and Sysadmin.
DELETE/v1/settings/{id}
Delete setting. Allowed to delete only for Sysadmin.
STATISTICS
STATISTICS CONTAIN SUMMARY AND TIMESERIES AND REQUIRE ADMIN OR GREATER.
GET/v1/statistics/summary
Get summary. A summary is a collection of statistics taken as a snapshot in time
when called. So a summary does not show historycal data, but onlt the current
values in the system. Allowed only if Admin or greater.
GET/v1/statistics/timeseries
Get statistics as timeseries. Allowed only if Admin or greater.
STATUSES
A STATUS IS ALWAYS ATTACHED TO AN APPLICATION. THIS COULD BE CAMERA STATUS,
DISKSPACE, CPU USAGE ETC. AN APPLICATION MAY HAVE MANY STATUSES AND EACH STATUS
WILL BELONG TO ONLY ONE APPLICATION.
GET/v1/statuses
List all statuses. Returns all statuses for Admin, or else the statuses
accessible to the logged in user.
POST/v1/statuses
Create a status. Allowed to create any status for Admin, or else the
applicationId assigned to the status must be accessible to the logged in user.
PUT/v1/statuses/{id}
Update a status. Allowed to update any status for Admin, or else the
applicationId assigned to the status and the status it self must be accessible
to the logged in user.
GET/v1/statuses/{id}
Get a status. Allowed to get any status if Admin, or else the statuses
accessible to the logged in user.
DELETE/v1/statuses/{id}
Delete a status. Allowed to delete any status for Admin, or else the status must
be accessible to the logged in user.
USERS
A USER IS SOMEONE WHO IS ALLOWED TO USE AN ASMIRA APPLICATION. ACCESS TO AN
ASMIRA APPLICATION DEPENDS ON THE TYPE (FIELD: LEVEL) OF USER. THESE ARE GUEST,
VIEWER, RECIEVER, SENDER, ADMIN AND SYSADMIN. A USER WITH ADMIN LEVEL HAS ACCESS
TO ALL USERS EXCEPT SYSADMINS, WHILE OTHER LOWER LEVEL USERS ARE RESTRICTED TO
THEIR OWN DATA. ADMINS ARE ALLOWED TO CREATE AND DELETE USERS OF LEVEL ADMIN AND
LOWER REGARDLESS OF OWNERSHIP. SYSADMINS ARE INVISIBLE TO LOWER LEVEL USERS AND
CAN MANAGE ALL USERS. A SYSADMIN IS INTENDED FOR MANAGING THE SETTINGS ENDPOINT
AS THIS CONTAINS DATA SUCH AS LICENCED_ROOMS WHICH SHOULD NOT BE ALLOWED TO BE
UPDATED BY ADMINS OR LOWER.
GET/v1/users
List all users. Returns all users for Admin, or else the logged in user.
POST/v1/users
Create a user. Allowed only for Admin.
PUT/v1/users/{id}
Update a user. Allowed to update any user if Admin, or else only allowed to
update the logged in user.
GET/v1/users/{id}
Get a user. Allowed to get any user if Admin, or else only the logged in user.
DELETE/v1/users/{id}
Delete a user. Allowed only for Admin.
POST/v1/users/{id}/resetPasswordKey
Create a reset password key for a given userId. This can be used to change the
password of the user. Allowed only for SysAdmin.
GET/v1/users/verifyResetPasswordKey/{key}
Verify resetPasswordKey. Upon verification success, returns the user allowed to
reset his/her password. Returns 400 if not verified.
PUT/v1/users/{id}/resetPassword
Reset the password for a given user using a resetPasswordKey.
USERROOMS
USERROOMS DESCRIBES THE RELATIONSHIP BETWEEN USERS AND ROOMS. SETTING UP WHICH
USERS HAVE ACCESS TO WHICH ROOMS IS DONE THROUGH THIS API. ONLY AN ADMIN IS
ALLOWED TO SETUP THESE RELATIONSHIPS. A USER MAY HAVE ACCESS TO 0 OR MORE
DIFFERENT ROOMS, AND A ROOM MAY ALLOW ACCESS TO 0 OR MORE DIFFERENT USERS.
GET/v1/userRooms
List all userRooms. Returns all userRooms for Admin, or else the userRooms
accessible to the logged in user.
POST/v1/userRooms
Create a userRoom. Allowed only for Admin.
PUT/v1/userRooms/{id}
Update a userRoom. Allowed only for Admin.
GET/v1/userRooms/{id}
Get a userRoom. Allowed to get any userRoom if Admin, or else the userRooms
accessible to the logged in user.
DELETE/v1/userRooms/{id}
Delete a userRoom. Allowed only for Admin.