Class Index

Classes


UserManager_POST

Creates new users
Defined in: userManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
UserManager_POST(users, pretty)
POST /wf/restapi/v2/admin/userManager: Creates new users or fails if the user already exists by the username.
Class Detail
UserManager_POST(users, pretty)
POST /wf/restapi/v2/admin/userManager: Creates new users or fails if the user already exists by the username.
Parameters:
users
An array of user objects to create. These objects should have the same structure as collected from UserManager_GET but without the "userId" attribute.
pretty Optional, Default: false
format the response to be human readable?
POST /wf/restapi/v2/admin/userManager
Body form-data:
users =
 [
  {
    "lastName": "user_last",
    "substitutionMap": {},
    "country": "USA",
    "city": "Minneapolis",
    "company": "",
    "state": "",
    "email": "",
    "zip": "55401",
    "ext": "",
    "address2": "",
    "address1": "",
    "dept": "Engineering",
    "firstName": "user",
    "phone": "",
    "middleName": "",
    "position": "vertical",
    "username": "user_1",
    "type": "Global Administrator",
    "status": "Active",
    "primaryGroup": 6,
    "groups": [
      0,
      6,
      8
    ]
  },
  {
    "username": "user_2"
  }
 ]
Response:
 [
  {
    "lastName": "user_last",
    "substitutionMap": {},
    "country": "USA",
    "city": "Minneapolis",
    "company": "",
    "state": "",
    "email": "",
    "zip": "55401",
    "ext": "",
    "address2": "",
    "address1": "",
    "dept": "Engineering",
    "userId": 3,
    "firstName": "user",
    "phone": "",
    "middleName": "",
    "position": "",
    "username": "user_1",
    "type": "Global Administrator",
    "status": "Active",
    "groups": [
      0,
      6,
      8
    ]
  },
  {
    "substitutionMap": {},
    "userId": 4,
    "username": "user_2",
    "type": "General User",
    "status": "Active",
    "groups": []
  }
 ]

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Dec 15 2023 01:44:02 GMT-0600 (CST)