Login API

Base Endpoint: POST https://api.vlenseg.com/api/Credentials/Login

Overview: This endpoint allows admin to log in by providing their username or email address, password, and tenancy name. Upon successful authentication, it returns important credentials such as the API key, bundle key, access token details, and a refresh token. These tokens are essential for making subsequent API requests.

Headers:

• ApiKey (required): The API key for authenticating the request.

• TenancyName (required): The tenancy name that identifies the tenant.

Login API

post

This endpoint allows admin to log in using their username or email, password, and tenancy name. On successful login, it returns an API key, bundle key, access token, and refresh token.

Header parameters

ApiKeystringRequired

TenancyNameanyRequired

Body

application/json

userNameOrEmailAddressstringOptionalExample: [email protected]

tenancyNamestringOptionalExample: admin

passwordstringOptionalExample: admin

Responses

200

Successful login

application/json

400

Bad request, missing or invalid fields

401

Unauthorized, invalid credentials

post

/api/credentials/Login

HTTPcURLJavaScriptPython

POST /api/credentials/Login HTTP/1.1
Host: 
ApiKey: text
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "userNameOrEmailAddress": "[email protected]",
  "tenancyName": "admin",
  "password": "admin"
}

{
  "data": {
    "apiKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "bundleKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "accessToken": "",
    "encryptedAccessToken": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "expireInSeconds": 86400,
    "shouldResetPassword": false,
    "passwordResetCode": null,
    "userId": 11113,
    "requiresTwoFactorVerification": false,
    "refreshToken": "eyJh",
    "refreshTokenExpireInSeconds": 31536000
  },
  "error_code": null,
  "error_message": null
}

JavaScript

const axios = require('axios');

const url = 'https://api.vlenseg.com/api/credentials/Login';
const headers = {
    'ApiKey': 'xxx',  // Replace with your actual API key
    'TenancyName': 'admin'  // Replace with your tenancy name
};
const data = {
    userNameOrEmailAddress: '[email protected]',
    tenancyName: 'admin',
    password: 'admin'
};

axios.post(url, data, { headers })
    .then(response => {
        console.log(response.data);
    })
    .catch(error => {
        console.error(`Error: ${error.response.status}`, error.response.data);
    });

Python

cURL