POST api/Authenticate

Authenticate a user with username and password as JSON in the request body.

Request Information

URI Parameters

None.

Body Parameters

UserName and password.

LoginRequestSimple
NameDescriptionTypeAdditional information
UserName

string

Required

Password

string

Required

Area

AreaEnum

Required

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "Area": 1
}

text/html

Sample:
{"UserName":"sample string 1","Password":"sample string 2","Area":1}

Response Information

Resource Description

Returns 200-OK with information about the user, 401-Unauthorized or 410-Gone if the user doesn't exist in this area (net or power).

LoginResponseExtended
NameDescriptionTypeAdditional information
CustomerIds

Collection of integer

None.

AuthProvider

string

None.

RegistrationStatus

string

None.

UserAuthId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CustomerIds": [
    1,
    2
  ],
  "AuthProvider": "sample string 1",
  "RegistrationStatus": "sample string 2",
  "UserAuthId": "sample string 3"
}

text/html

Sample:
{"CustomerIds":[1,2],"AuthProvider":"sample string 1","RegistrationStatus":"sample string 2","UserAuthId":"sample string 3"}