Create User

Creates a user.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of the tenant

Request Body

application/json

  • loginNamestring

    User login name.

  • lastNamestring

    User last name

  • firstNamestring

    User first name.

  • emailstring

    Email of the user. (Alert and report notifications are sent to the email address.)

  • idstring

  • changePasswordboolean

  • designationstring

    User designation.

  • addressstring

    User address.

  • citystring

    City name.

  • statestring

    State name.

  • zipstring

    Zip code.

  • countrystring

    Country name. To get the list of countries, use Get Countries API.

  • altEmailstring

  • phoneNumberstring

    User phone number.

  • mobileNumberstring

    User mobile number.

  • timeZoneobject

    Time zone of the country. Use the Get Timezones API to get the list of timezones.

  • userNotificationsarray

    Email to which the alert and report notifications are sent.

  • rolesarray

    Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.

  • userGroupsarray

    Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.

  • passwordstring

    Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character

  • userAccountTypestring

    User account type: - REGULAR - BUSINESS

    Enum:
    REGULARBUSINESS
  • userGroupTypestring

    Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE

    Enum:
    ALLNONE
  • authTypestring

  • statusstring

  • orgIdstring

  • profileImageobject

  • createdTimestring

  • organizationNamestring

  • updatedTimestring

  • userAccessTypesarray of strings

    Supported userAccessTypes : NOTIFICATION_USER, API_USER, PORTAL_USER. Note: notification users can not be API or PORTAL Users.

    Enum:
    NOTIFICATION_USERAPI_USERPORTAL_USER

Request Body Samples

{
  "loginName": "ScarletJohn",
  "password": "ChangeMe@1234",
  "firstName": "Scarlet",
  "lastName": "John",
  "designation": "Architect",
  "address": "300 BOYLSTON AVE E",
  "city": "SEATTLE ",
  "state": "WA",
  "zip": "98102",
  "country": "United States",
  "email": "scarlet@gmail.com",
  "altEmail": "scarletjohn@gmail.com",
  "phoneNumber": "206-232-4543",
  "mobileNumber": "623-731-1540",
  "timeZone": {
    "code": "EST",
    "name": "Europe/Istanbul"
  },
  "userNotifications": [
    {
      "notifyType": "Account Information",
      "notifyMethod": "Email",
      "notifyInputType": "Primary Email",
      "notifyRecurringReport": false
    },
    {
      "notifyType": "Alert Notification",
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false
    },
    {
      "notifyType": "Report Notification",
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false
    }
  ],
  "roles": [
    {
      "name": "Client Administrator"
    },
    {
      "name": "Client User"
    },
    {
      "name": "Customer"
    },
    {
      "name": "End User View"
    },
    {
      "name": "ACS Client Administrator"
    }
  ],
  "userGroups": [
    {
      "name": "Implementation Team"
    },
    {
      "name": "Architecture Department"
    }
  ]
}

Responses

  • loginNamestring

    User login name.

  • lastNamestring

    User last name

  • firstNamestring

    User first name.

  • emailstring

    Email of the user. (Alert and report notifications are sent to the email address.)

  • idstring

  • changePasswordboolean

  • designationstring

    User designation.

  • addressstring

    User address.

  • citystring

    City name.

  • statestring

    State name.

  • zipstring

    Zip code.

  • countrystring

    Country name. To get the list of countries, use Get Countries API.

  • altEmailstring

  • phoneNumberstring

    User phone number.

  • mobileNumberstring

    User mobile number.

  • timeZoneobject

    Time zone of the country. Use the Get Timezones API to get the list of timezones.

  • userNotificationsarray

    Email to which the alert and report notifications are sent.

  • rolesarray

    Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to get roles created under a partner or client.

  • userGroupsarray

    Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to get details of user groups.

  • passwordstring

    Password must have a minimum of 7 characters with at least: - One number (0-9) - One special character (#,!, $,*) - One lowercase (a-z) - One uppercase (A-Z) character

  • userAccountTypestring

    User account type: - REGULAR - BUSINESS

    Enum:
    REGULARBUSINESS
  • userGroupTypestring

    Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE - If a user should be part of all user groups, provide userGroupType: ALL - If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] - If a user should NOT be part of any user group, provide userGroupType: NONE

    Enum:
    ALLNONE
  • authTypestring

  • statusstring

  • orgIdstring

  • profileImageobject

  • createdTimestring

  • organizationNamestring

  • updatedTimestring

  • userAccessTypesarray of strings

    Supported userAccessTypes : NOTIFICATION_USER, API_USER, PORTAL_USER. Note: notification users can not be API or PORTAL Users.

    Enum:
    NOTIFICATION_USERAPI_USERPORTAL_USER

Response Samples

{
  "id": "USR0000002145",
  "loginName": "ScarletJohn",
  "lastName": "John",
  "firstName": "Scarlet",
  "email": "scarlet@gmail.com",
  "altEmail": "scarletjohn@gmail.com",
  "userAccountType": "REGULAR",
  "designation": "Architect",
  "address": "300 BOYLSTON AVE E",
  "city": "SEATTLE ",
  "state": "WA",
  "country": "United States",
  "zip": "98102",
  "phoneNumber": "206-232-4543",
  "mobileNumber": "623-731-1540",
  "timeZone": {
    "id": "7",
    "name": "America/New_York",
    "label": "GMT -05:00 Eastern",
    "code": "EST"
  },
  "roles": [
    {
      "id": 4,
      "name": "Client Administrator"
    },
    {
      "id": 5,
      "name": "Client User"
    },
    {
      "id": 6,
      "name": "Customer"
    },
    {
      "id": 9,
      "name": "End User View"
    },
    {
      "id": 10,
      "name": "ACS Client Administrator"
    }
  ],
  "authType": "LOCAL",
  "userGroups": [
    {
      "uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567",
      "name": "Implementation Team"
    },
    {
      "uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff",
      "name": "Architecture Department"
    }
  ],
  "status": "active",
  "orgId": "client_16",
  "profileImage": {
    "logoPath": "https://yourdomain.com/img/nophoto.gif",
    "thumbPath": "https://yourdomain.com/img/nophoto.gif",
    "tinyThumbPath": "https://yourdomain.com/img/wall_img1.gif"
  },
  "organizationName": "Luminalto",
  "userNotifications": [
    {
      "notifyType": "Account Information",
      "notifyMethod": "Email",
      "notifyInputType": "Primary Email",
      "notifyRecurringReport": false
    },
    {
      "notifyType": "Alert Notification",
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false
    },
    {
      "notifyType": "Report Notification",
      "notifyMethod": "No Notify",
      "notifyRecurringReport": false
    }
  ],
  "createdTime": "2016-11-01T11:54:24+0000",
  "updatedTime": "2016-11-01T11:54:24+0000"
}