Skip to main content
GET
/
user
/
get-screen-name
/
{screenName}
Find User By Screen Name
curl --request GET \
  --url https://apigw.bienport.com/api/user/get-screen-name/{screenName} \
  --header 'Authorization: <authorization>' \
  --header 'OrganizationId: <organizationid>'
import requests

url = "https://apigw.bienport.com/api/user/get-screen-name/{screenName}"

headers = {
"Authorization": "<authorization>",
"OrganizationId": "<organizationid>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {Authorization: '<authorization>', OrganizationId: '<organizationid>'}
};

fetch('https://apigw.bienport.com/api/user/get-screen-name/{screenName}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://apigw.bienport.com/api/user/get-screen-name/{screenName}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"OrganizationId: <organizationid>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://apigw.bienport.com/api/user/get-screen-name/{screenName}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<authorization>")
req.Header.Add("OrganizationId", "<organizationid>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://apigw.bienport.com/api/user/get-screen-name/{screenName}")
.header("Authorization", "<authorization>")
.header("OrganizationId", "<organizationid>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://apigw.bienport.com/api/user/get-screen-name/{screenName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["OrganizationId"] = '<organizationid>'

response = http.request(request)
puts response.read_body
{
  "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,
              "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,
          "trueValue": "<string>",
          "falseValue": "<string>",
          "description": "<string>",
          "controllerName": "<string>",
          "controllerId": 123,
          "partitions": [
            {
              "name": "<string>",
              "no": 123
            }
          ]
        }
      ],
      "resourceSubscriptionId": 123,
      "subscriptionDocumentNo": "<string>",
      "deviceSubType": "<string>"
    }
  ]
}
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}
This response has no body data.
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}
{
"statusCode": 123,
"error": "***Exception",
"message": "Message about the error",
"path": "/api/example/path"
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Path Parameters

screenName
string
required

screenName

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[]