AdminLogin

POST

https://api.vlenseg.com/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

1 {
2   "data": {
3     "hasPendingRequest": "<boolean>",
4     "isEmailConfirmationRequired": "<boolean>",
5     "isEmailConfirmed": "<boolean>",
6     "isPhoneNumberConfirmationRequired": "<boolean>",
7     "isPhoneNumberConfirmed": "<boolean>",
8     "phoneNumberOtp": "<string>",
9     "phoneNumberOtpRequestId": "<uuid>",
10     "isDigitalIdentityVerified": "<boolean>",
11     "accessToken": "<string>",
12     "encryptedAccessToken": "<string>",
13     "expireInSeconds": "<integer>",
14     "userName": "<string>",
15     "userFullName": "<string>",
16     "user": {
17       "name": "<string>",
18       "surname": "<string>",
19       "fullName": "<string>",
20       "userName": "<string>",
21       "emailAddress": "<string>",
22       "phoneNumber": "<string>",
23       "idNumber": "<string>"
24     }
25   },
26   "error_code": "<integer>",
27   "error_message": "<string>"
28 }

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_codestring

error_messagestring