Admin Login

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.

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

tenancyNamestring · max: 256Required

userNameOrEmailAddressstring · max: 256Required

passwordstring · max: 32Required

Responses

200

Success

text/plainapplication/jsontext/json

post

/api/credentials/Login

HTTPcURLJavaScriptPython

POST /api/credentials/Login HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 72

{
  "tenancyName": "text",
  "userNameOrEmailAddress": "text",
  "password": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

Success

{
  "data": {
    "accessToken": "text",
    "encryptedAccessToken": "text",
    "expireInSeconds": 1,
    "shouldResetPassword": true,
    "passwordResetCode": "text",
    "userId": 1,
    "requiresTwoFactorVerification": true,
    "twoFactorAuthProviders": [
      "text"
    ],
    "twoFactorRememberClientToken": "text",
    "returnUrl": "text",
    "refreshToken": "text",
    "refreshTokenExpireInSeconds": 1
  },
  "error_code": 1,
  "error_message": "text",
  "error_descriptions": null
}

post

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

refreshTokenstring · nullableOptional

Responses

200

Success

text/plainapplication/jsontext/json

post

/api/credentials/RefreshToken

HTTPcURLJavaScriptPython

POST /api/credentials/RefreshToken HTTP/1.1
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 23

{
  "refreshToken": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

Success

{
  "data": {
    "refreshToken": "text",
    "newRefreshToken": "text",
    "accessToken": "text",
    "encryptedAccessToken": "text",
    "expireInSeconds": 1
  },
  "error_code": 1,
  "error_message": "text",
  "error_descriptions": 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': 'Test'  // 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