Skip to main content
GET
/
user
/
email
/
{emailAddress}
Find User By Email
curl --request GET \
  --url https://apigw.bienport.com/api/user/email/{emailAddress} \
  --header 'Authorization: <authorization>' \
  --header 'OrganizationId: <organizationid>'
{
  "userId": 123,
  "instanceId": 123,
  "instanceName": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "emailAddressVerified": true,
  "status": 123,
  "nationalId": 123,
  "screenName": "<string>",
  "emailAddress": "<string>",
  "timeZoneId": "<string>",
  "localeId": "<string>",
  "organizations": [
    {
      "name": "<string>",
      "id": 123
    }
  ],
  "organizationIds": [
    123
  ],
  "roles": [
    {
      "roleId": 123,
      "roleName": "<string>",
      "type": 123,
      "inherited": true,
      "typePK": 123,
      "typeName": "<string>"
    }
  ],
  "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>"
    }
  ]
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Path Parameters

emailAddress
string
required

emailAddress

Response

User.

User response model

userId
integer<int64>
instanceId
integer<int64>
instanceName
string
firstName
string
middleName
string
lastName
string
emailAddressVerified
boolean
status
integer<int32>
nationalId
integer<int64>
screenName
string
emailAddress
string
timeZoneId
string
localeId
string
organizations
Organization · object[]
organizationIds
integer<int64>[]
roles
RoleResponse · object[]
resources
GetResourceResponse · object[]