Skip to main content
POST
/
user
/
add
Add User
curl --request POST \
  --url https://apigw.bienport.com/api/user/add \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'OrganizationId: <organizationid>' \
  --data '
{
  "firstName": "Mustafa",
  "locale": "tr_TR",
  "password1": "123qweasdzx",
  "password2": "123qweasdzx",
  "screenName": "90xxxxxxxxxx",
  "birthdayDay": 1,
  "birthdayMonth": 1,
  "birthdayYear": 1970,
  "emailAddress": "[email protected]",
  "lastName": "Atatürk",
  "male": true,
  "middleName": "Kemal",
  "nationalId": 11111111111,
  "organizationIds": [
    14,
    65
  ],
  "roleIds": [
    123
  ],
  "subscriptionIds": [
    123,
    133
  ]
}
'
{
  "status": false,
  "user": {
    "userId": 123,
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "screenName": "<string>",
    "nationalId": 123,
    "organizations": [
      {
        "name": "<string>",
        "id": 123
      }
    ],
    "organizationIds": [
      123
    ],
    "modifiedDate": 123,
    "languageId": "<string>",
    "failedLoginAttempts": 123,
    "status": 123,
    "emailAddress": "<string>",
    "timeZoneId": "<string>",
    "contactId": 123,
    "lockout": true,
    "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>"
      }
    ]
  },
  "message": "SMS sent. / SMS not sent.",
  "userId": 235234
}

Headers

Authorization
string
required

Access Token

OrganizationId
string
required

Organization ID

Body

application/json

addNewPortalUserRequest

User Add Request Model

firstName
string
required

First Name

Example:

"Mustafa"

locale
string
required

Locale

Example:

"tr_TR"

password1
string
required
Example:

"123qweasdzx"

password2
string
required

Repeat Password

Example:

"123qweasdzx"

screenName
string
required

Screen Name

Example:

"90xxxxxxxxxx"

birthdayDay
integer<int32>

Birthday Day(Optional)

Example:

1

birthdayMonth
integer<int32>

Birthday Month(Optional)

Example:

1

birthdayYear
integer<int32>

Birthday Year(Optional)

Example:

1970

emailAddress
string

Email Address(Optional)

lastName
string

Last Name(Optional)

Example:

"Atatürk"

male
boolean

Gender(Optional)

Example:

true

middleName
string

Middle Name(Optional)

Example:

"Kemal"

nationalId
integer<int64>

User national ID

Example:

11111111111

organizationIds
integer<int64>[]

Organization Ids(Optional)

Example:
[14, 65]
roleIds
integer<int64>[]

Role Ids(Optional)

subscriptionIds
integer<int64>[]

User subscription Ids

Example:
[123, 133]

Response

Created User.

status
boolean

The sending status of the SMS.

Example:

false

user
AddNewUserResponse · object

Add User response model

message
string

The sending message of the SMS.

Example:

"SMS sent. / SMS not sent."

userId
integer<int64>

User ID. ( If a verification code is requested again, it will return. )

Example:

235234