Virima API Specification - LoginService Services

The requests documented in this section are directed to LoginService resources, which represent User login, logout,createAccount and gets loggedin user -- as called by a partner or directly by a webapp using the API..

Contents

1 doLogin POST Interface
2 doLoginImpersonate POST Interface
3 doLogout GET Interface
4 getLoggedInUser GET Interface
5 resetPasswordSendMail POST Interface
6 resetPassword POST Interface
7 initialSetUpWizard POST Interface

doLogin POST Interface

dologin Service (POST) is called when a partner, or the application is trying to login using user credential.

Checks for mandatory fields(user name and password)
User data is verified with existing data
if data is existing in our database. dose the authentication check
Create a session for a given email and password

Method: POST

Relative URL: login/dologin

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
credential	Credential

Response Structure:

Field Name	Type	Description
user	UserDetails

Example Request:

DOLOGIN 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "password":"?",
   "demoUser":"?",
   "enableMFA":?,
   "customerId":"?",
   "clientName":"?",
   "oldSessionId":"?",
   "client": {
         "clientSessionId":"?",
         "state":?,
         "addedOn":?,
         "currentStateTime":?,
         "hostName":"?",
         "name":"?",
         "clientName":"?",
         "ipAddress":"?",
         "subnet":"?",
         "currentStatus":"?",
         "archive":?,
         "customerId":?,
         "uniqueId":"?",
         "location": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "userId":"?",
         "operatingSystem":"?",
         "serverIpAddress":"?",
         "serverDNSName":"?",
         "noOfAssetsDiscovered":?,
         "version":"?",
         "proxy":?,
         "agentScanEnabled":?,
         "agentAutoUpdateThroughAppEnabled":?,
         "autoUpdateApp":?,
         "lastStatusUpdate":?,
         "latestVersionFoClient":"?",
         "fqdn":"?",
         "liveConnectionServerSSL":?,
         "liveConnectionServerPort":"?",
         "webservicesPort":"?",
         "certificate":"?",
         "serialNumber":"?"
      }
}

Example Response:

{
   "id":688446288,
   "email":"?",
   "password":"?",
   "userName":"?",
   "isAdmin":?,
   "isEndUser":?,
   "isCustomer":?,
   "firstName":"?",
   "lastName":"?",
   "displayName":"?",
   "phone":"?",
   "uniqueId":"?",
   "timeStamp":"?",
   "fileName":"?",
   "bucketName":"?",
   "wikiLink":"?",
   "logoPic":"?",
   "theme":"?",
   "Url":"?",
   "landingPage":"?",
   "currency":"?",
   "language":"?",
   "isVendor":?,
   "sessionId":"?",
   "isLocalStorage":"?",
   "downloadLink":"?",
   "storageType":"?",
   "driveLink":"?",
   "driveLinkForOrganization":"?",
   "chatServerAddress":"?",
   "isSuperAdmin":?,
   "organizationName":"?",
   "integrationEnabled":?,
   "serviceNowDomain":"?",
   "serverPort":"?",
   "nettyPort":"?",
   "severAddress":"?",
   "isSuperEndUser":?,
   "ivantiDomain":"?",
   "jiraDomain":"?",
   "isCherwellIntegrationEnabled":?,
   "subscribedModules":"?",
   "newUIEnabled":?,
   "enableMFA":?,
   "mfaChecked":?,
   "twoFactorSecretKey":"?",
   "mfaType":"?",
   "timezone":"?"
}

doLoginImpersonate POST Interface

Impersionate user login

Method: POST

Relative URL: login/dologin-impersonate

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
credential	Credential

Response Structure:

Field Name	Type	Description
user	UserDetails

Example Request:

DOLOGINIMPERSONATE 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "password":"?",
   "demoUser":"?",
   "enableMFA":?,
   "customerId":"?",
   "clientName":"?",
   "oldSessionId":"?",
   "client": {
         "clientSessionId":"?",
         "state":?,
         "addedOn":?,
         "currentStateTime":?,
         "hostName":"?",
         "name":"?",
         "clientName":"?",
         "ipAddress":"?",
         "subnet":"?",
         "currentStatus":"?",
         "archive":?,
         "customerId":?,
         "uniqueId":"?",
         "location": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "userId":"?",
         "operatingSystem":"?",
         "serverIpAddress":"?",
         "serverDNSName":"?",
         "noOfAssetsDiscovered":?,
         "version":"?",
         "proxy":?,
         "agentScanEnabled":?,
         "agentAutoUpdateThroughAppEnabled":?,
         "autoUpdateApp":?,
         "lastStatusUpdate":?,
         "latestVersionFoClient":"?",
         "fqdn":"?",
         "liveConnectionServerSSL":?,
         "liveConnectionServerPort":"?",
         "webservicesPort":"?",
         "certificate":"?",
         "serialNumber":"?"
      }
}

Example Response:

{
   "id":2147483647,
   "email":"?",
   "password":"?",
   "userName":"?",
   "isAdmin":?,
   "isEndUser":?,
   "isCustomer":?,
   "firstName":"?",
   "lastName":"?",
   "displayName":"?",
   "phone":"?",
   "uniqueId":"?",
   "timeStamp":"?",
   "fileName":"?",
   "bucketName":"?",
   "wikiLink":"?",
   "logoPic":"?",
   "theme":"?",
   "Url":"?",
   "landingPage":"?",
   "currency":"?",
   "language":"?",
   "isVendor":?,
   "sessionId":"?",
   "isLocalStorage":"?",
   "downloadLink":"?",
   "storageType":"?",
   "driveLink":"?",
   "driveLinkForOrganization":"?",
   "chatServerAddress":"?",
   "isSuperAdmin":?,
   "organizationName":"?",
   "integrationEnabled":?,
   "serviceNowDomain":"?",
   "serverPort":"?",
   "nettyPort":"?",
   "severAddress":"?",
   "isSuperEndUser":?,
   "ivantiDomain":"?",
   "jiraDomain":"?",
   "isCherwellIntegrationEnabled":?,
   "subscribedModules":"?",
   "newUIEnabled":?,
   "enableMFA":?,
   "mfaChecked":?,
   "twoFactorSecretKey":"?",
   "mfaType":"?",
   "timezone":"?"
}

doLogout GET Interface

dologout Service (GET) is called when a partner, or the application is trying to logout.

Kills an active session

Method: GET

Relative URL: login/dologout

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
transactionMeassage	TransactionMessage

Example Request:

Example Response:

{
   "id":2147483647,
   "recordId":"?",
   "message":"?",
   "status":?
}

getLoggedInUser GET Interface

GetLoggedInUser Service (GET) is called when a partner, or the application is trying to create an account.

Checks for mandatory fields(user name and password)
Returns the loggedin user

Method: GET

Relative URL: login/get-logged-in-user

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Response Structure:

Field Name	Type	Description
user	UserDetails

Example Request:

Example Response:

{
   "id":2147483647,
   "email":"?",
   "password":"?",
   "userName":"?",
   "isAdmin":?,
   "isEndUser":?,
   "isCustomer":?,
   "firstName":"?",
   "lastName":"?",
   "displayName":"?",
   "phone":"?",
   "uniqueId":"?",
   "timeStamp":"?",
   "fileName":"?",
   "bucketName":"?",
   "wikiLink":"?",
   "logoPic":"?",
   "theme":"?",
   "Url":"?",
   "landingPage":"?",
   "currency":"?",
   "language":"?",
   "isVendor":?,
   "sessionId":"?",
   "isLocalStorage":"?",
   "downloadLink":"?",
   "storageType":"?",
   "driveLink":"?",
   "driveLinkForOrganization":"?",
   "chatServerAddress":"?",
   "isSuperAdmin":?,
   "organizationName":"?",
   "integrationEnabled":?,
   "serviceNowDomain":"?",
   "serverPort":"?",
   "nettyPort":"?",
   "severAddress":"?",
   "isSuperEndUser":?,
   "ivantiDomain":"?",
   "jiraDomain":"?",
   "isCherwellIntegrationEnabled":?,
   "subscribedModules":"?",
   "newUIEnabled":?,
   "enableMFA":?,
   "mfaChecked":?,
   "twoFactorSecretKey":"?",
   "mfaType":"?",
   "timezone":"?"
}

resetPasswordSendMail POST Interface

dologin Service (POST) is called when a partner, or the application wants to reset the credentials.

An email will be sent to the corresponding user with a unique link to reset password.

Method: POST

Relative URL: login/reset-password-send-mail

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
credential	Credential

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

RESETPASSWORDSENDMAIL 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "password":"?",
   "demoUser":"?",
   "enableMFA":?,
   "customerId":"?",
   "clientName":"?",
   "oldSessionId":"?",
   "client": {
         "clientSessionId":"?",
         "state":?,
         "addedOn":?,
         "currentStateTime":?,
         "hostName":"?",
         "name":"?",
         "clientName":"?",
         "ipAddress":"?",
         "subnet":"?",
         "currentStatus":"?",
         "archive":?,
         "customerId":?,
         "uniqueId":"?",
         "location": {
               "stringobj":"?",
               "shortName":"?",
               "s3Name":"?",
               "uniqueId":"?",
               "lineType":"?",
            },
         "userId":"?",
         "operatingSystem":"?",
         "serverIpAddress":"?",
         "serverDNSName":"?",
         "noOfAssetsDiscovered":?,
         "version":"?",
         "proxy":?,
         "agentScanEnabled":?,
         "agentAutoUpdateThroughAppEnabled":?,
         "autoUpdateApp":?,
         "lastStatusUpdate":?,
         "latestVersionFoClient":"?",
         "fqdn":"?",
         "liveConnectionServerSSL":?,
         "liveConnectionServerPort":"?",
         "webservicesPort":"?",
         "certificate":"?",
         "serialNumber":"?"
      }
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

resetPassword POST Interface

dologin Service (POST) is called when a partner, or the application is trying to reset the credential.

Checks if the user and instance is valid
If so resets the password to the new password

Method: POST

Relative URL: login/reset-password

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
resetPassword	ResetPassword

Response Structure:

Field Name	Type	Description
resp	Response

Example Request:

RESETPASSWORD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "instance":"?",
   "password":"?",
   "directPasswordChange":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

initialSetUpWizard POST Interface

initialSetUpWizard Service (POST) is called when user sign in immediate after once user signed up.

Get details about creating new users, department, designation, location, holidays and operational hours

Method: POST

Relative URL: login/initial-set-up-wizard

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
wizardInput	SetUpWizard

Response Structure:

Field Name	Type	Description
resp	UserDetails

Example Request:

INITIALSETUPWIZARD 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "email":"?",
   "password":"?",
   "wizardJson":"?"
}

Example Response:

{
   "id":2147483647,
   "email":"?",
   "password":"?",
   "userName":"?",
   "isAdmin":?,
   "isEndUser":?,
   "isCustomer":?,
   "firstName":"?",
   "lastName":"?",
   "displayName":"?",
   "phone":"?",
   "uniqueId":"?",
   "timeStamp":"?",
   "fileName":"?",
   "bucketName":"?",
   "wikiLink":"?",
   "logoPic":"?",
   "theme":"?",
   "Url":"?",
   "landingPage":"?",
   "currency":"?",
   "language":"?",
   "isVendor":?,
   "sessionId":"?",
   "isLocalStorage":"?",
   "downloadLink":"?",
   "storageType":"?",
   "driveLink":"?",
   "driveLinkForOrganization":"?",
   "chatServerAddress":"?",
   "isSuperAdmin":?,
   "organizationName":"?",
   "integrationEnabled":?,
   "serviceNowDomain":"?",
   "serverPort":"?",
   "nettyPort":"?",
   "severAddress":"?",
   "isSuperEndUser":?,
   "ivantiDomain":"?",
   "jiraDomain":"?",
   "isCherwellIntegrationEnabled":?,
   "subscribedModules":"?",
   "newUIEnabled":?,
   "enableMFA":?,
   "mfaChecked":?,
   "twoFactorSecretKey":"?",
   "mfaType":"?",
   "timezone":"?"
}