POST api/v1/authorizations

Login and return current user including user api token. Currently only standard users and tenant admins are supported

Request Information

URI Parameters

None.

Body Parameters

Creds
NameDescriptionTypeAdditional information
user

string

None.

password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "user": "sample string 1",
  "password": "sample string 2"
}

application/x-www-form-urlencoded

Sample:
user=sampleuser&password=samplepassword

Response Information

Resource Description

CurrentUser
NameDescriptionTypeAdditional information
Id

Id of the user

string

None.

UserName

Name (first last)

string

None.

Email

Email address

string

None.

PhoneNumber

Phone number (Full number)

string

None.

Extension

NetPBX extension number

string

None.

TenantId

Id of the tenant

integer

None.

Role

The role of the user (4 = User, 3 = Tenant Admin)

integer

None.

API_Token

User unique token/key for accessing the web api.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "UserName": "sample string 2",
  "Email": "sample string 3",
  "PhoneNumber": "sample string 4",
  "Extension": "sample string 5",
  "TenantId": 6,
  "Role": 7,
  "API_Token": "sample string 8"
}