Documentation

Generating Secret Key

Generating Secret Key API Secret Key is a software credential that allows a program to access a user account without the actual  Password.It has an encrypted code that works as an identifier when sent to the API server. This secret key is used for generating a access token. This document provides steps to generate a

Generating Secret Key Read More »

Installing API Service

Installing API Service API service enables external system to integrate with NirvaShare allowing to manage some of the admin tasks such as creating, editing, deleting shares, login profiles, access users, etc. This document explains how to install API service in NirvaShare. The installation can be performed using a single install script. Once you run the

Installing API Service Read More »

API Error Responses

API Error Responses The following document provides details of error responses obtained while executing different APIs. Response Body { "status": 400, "errorType": 1, "message": "invalid auth header", "timestamp": "2024-08-20T11:52:06.358+00:00" } Property Description status Indicates the http error status code like 401, 500, etc errorType error type message Cause of the error. timestamp Timestamp when the

API Error Responses Read More »

Login Profile API

Login Profile API This API performs actions such as updating login profile, updating viewid, getting Login profile, duplicating Login profile, adding Login Profile, searching for a Login profile and deleting a Login Profile. Update POST ​/api​/v1​/loginprofile​/update This API is essential for updating the login profile. Request Body { "id": 0, "title": "string", "description": "string", "ipRange":

Login Profile API Read More »

Access User API

Access User API Access user API allows operations such as create, edit, delete, etc with Access users. Update POST ​/api​/v1​/accessuser​/update This API updates an Access User. Request Body { "id": 0, "firstName": "string", "lastName": "string", "email": "string", "authId": 0, "active": true } Property Mandatory Description id yes Access user id firstname no first name of

Access User API Read More »