Skip to main content
POST
/
auth
/
login
Authenticate User
curl --request POST \
  --url https://apigw.bienport.com/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "screenName": "905554447788",
  "password": "mypass+",
  "rememberMe": true
}
'
{
  "token": "Bearer Token",
  "mqUser": "messenger",
  "mqPassword": "password-here",
  "userId": 11234,
  "emailAddress": "<string>",
  "screenName": "<string>",
  "localeId": "<string>",
  "roles": [
    {
      "roleId": 123,
      "roleName": "<string>",
      "type": 123,
      "inherited": true,
      "typePK": 123,
      "typeName": "<string>"
    }
  ],
  "organizations": [
    {
      "name": "OrganizationName",
      "id": "243242"
    }
  ],
  "organizationIds": [
    30339,
    43567
  ],
  "resources": [
    {
      "resourceId": 123,
      "networkId": "<string>",
      "resourceName": "<string>",
      "enabled": true,
      "modelName": "<string>",
      "brandName": "<string>",
      "treePath": "<string>",
      "orgId": 123,
      "resourceSensors": [
        {
          "type": "<string>",
          "sensors": [
            {
              "id": 123,
              "resourceId": 123,
              "orderNo": 123,
              "ioType": "Digital",
              "ioDirection": "Input",
              "trueValue": "<string>",
              "falseValue": "<string>",
              "partitions": [
                {
                  "name": "<string>",
                  "no": 123
                }
              ],
              "sensorId": 123,
              "description": "<string>",
              "hardwareSerialNumber": "<string>",
              "sensorName": "<string>"
            }
          ]
        }
      ],
      "resourceControllers": [
        {
          "hardwareSerialNumber": "<string>",
          "id": 123,
          "resourceId": 123,
          "orderNo": 123,
          "ioType": "Digital",
          "ioDirection": "Input",
          "trueValue": "<string>",
          "falseValue": "<string>",
          "description": "<string>",
          "controllerName": "<string>",
          "controllerId": 123,
          "partitions": [
            {
              "name": "<string>",
              "no": 123
            }
          ]
        }
      ],
      "resourceSubscriptionId": 123,
      "subscriptionDocumentNo": "<string>",
      "resourceType": "Device",
      "deviceSubType": "<string>"
    }
  ]
}

Body

application/json

loginRequest

screenName
string

Enter phone number.

Example:

"905554447788"

password
string

Enter your password.

Example:

"mypass+"

rememberMe
boolean

Want to be remembered for next entries?

Example:

true

Response

JWT token, user details

token
string

Token

Example:

"Bearer Token"

mqUser
string

Message Queue User Name

Example:

"messenger"

mqPassword
string

Message Queue Password

Example:

"password-here"

userId
integer<int64>

User Id

Example:

11234

emailAddress
string

Email Address

screenName
string

Screen Name

localeId
string

Locale

roles
RoleResponse · object[]

Roles

organizations
Organization · object[]

Organization Ids

Example:
[
{
"name": "OrganizationName",
"id": "243242"
}
]
organizationIds
integer<int64>[]

Organizations

Example:
[30339, 43567]
resources
GetResourceResponse · object[]

Resources