AdminLogin

POST

/api/credentials/Login

POST

/api/credentials/Login

curl -X POST https://api.vlenseg.com/api/credentials/Login \
     -H "ApiKey: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "userNameOrEmailAddress": "{{adminUser}}",
  "password": "{{adminUserPass}}",
  "tenancyName": "{{tenancyName}}"
}'

200Credentials_postCredentialsLogin_example

{
  "data": {
    "hasPendingRequest": false,
    "isEmailConfirmationRequired": false,
    "isEmailConfirmed": true,
    "isPhoneNumberConfirmationRequired": false,
    "isPhoneNumberConfirmed": true,
    "phoneNumberOtp": "<string>",
    "phoneNumberOtpRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "isDigitalIdentityVerified": true,
    "accessToken": "<string>",
    "encryptedAccessToken": "<string>",
    "expireInSeconds": 3600,
    "userName": "<string>",
    "userFullName": "<string>",
    "user": {
      "name": "<string>",
      "surname": "<string>",
      "fullName": "<string>",
      "userName": "<string>",
      "emailAddress": "<string>",
      "phoneNumber": "<string>",
      "idNumber": "<string>"
    }
  },
  "error_code": null,
  "error_message": null
}

Authentication

ApiKeystring

Static API key issued to your tenant. Required on every request.

Request

This endpoint expects an object.

userNameOrEmailAddressstringRequired

passwordstringRequired

tenancyNamestringRequired

Response

dataobject

error_codeinteger or null

error_messagestring or null