UserManager_GET

Collects user info
Defined in: userManager.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	UserManager_GET(userId, username, pretty) GET /wf/restapi/v2/admin/userManager: This endpoint can collect all users info or a specific users info given the "userId" or "username"

Class Detail

UserManager_GET(userId, username, pretty)

GET /wf/restapi/v2/admin/userManager: This endpoint can collect all users info or a specific users info given the "userId" or "username"

Parameters:
userId Optional: search for a specific user by user id
username Optional: search for a specific user by username
pretty Optional, Default: false: format the response to be human readable?

GET /wf/restapi/v2/admin/userManager
Response:

 [
  {
    "lastName": "",
    "substitutionMap": {
      "$username": "root",
      "$today": "2020-07-31",
      "$user:ldap:position": "dbadmin"
    },
    "country": "",
    "city": "",
    "company": "",
    "state": "",
    "email": "root@localhost",
    "zip": "",
    "ext": "",
    "address2": "",
    "address1": "",
    "dept": "",
    "userId": 1,
    "firstName": "",
    "phone": "",
    "middleName": "",
    "position": "dbadmin",
    "username": "root",
    "type": "Global Administrator",
    "status": "Active",
    "primaryGroup": 6,
    "groups": [
      6,
      8
    ]
  },
 {
    "lastName": "tester",
    "substitutionMap": {},
    "country": "Belgium",
    "city": "Gent",
    "company": "Esko",
    "state": "",
    "email": "tester@localhost.com",
    "zip": "BE-9051",
    "ext": "",
    "address2": "",
    "address1": "Kortrijksesteenweg 1095",
    "dept": "Engineering",
    "userId": 7,
    "firstName": "test",
    "phone": "",
    "middleName": "a",
    "position": "Engineer",
    "username": "testUser",
    "type": "Global Administrator",
    "status": "Active",
    "primaryGroup": 6,
    "groups": [
      0,
      6,
      8
    ]
  }
 ]

GET /wf/restapi/v2/admin/userManager?username=testUser
Response:

 [
  {
    "lastName": "tester",
    "substitutionMap": {},
    "country": "Belgium",
    "city": "Gent",
    "company": "Esko",
    "state": "",
    "email": "tester@localhost.com",
    "zip": "BE-9051",
    "ext": "",
    "address2": "",
    "address1": "Kortrijksesteenweg 1095",
    "dept": "Engineering",
    "userId": 7,
    "firstName": "test",
    "phone": "",
    "middleName": "a",
    "position": "Engineer",
    "username": "testUser",
    "type": "Global Administrator",
    "status": "Active",
    "primaryGroup": 6,
    "groups": [
      0,
      6,
      8
    ]
  }
 ]

GET /wf/restapi/v2/admin/userManager?userId=7
Response:

 [
  {
    "lastName": "tester",
    "substitutionMap": {},
    "country": "Belgium",
    "city": "Gent",
    "company": "Esko",
    "state": "",
    "email": "tester@localhost.com",
    "zip": "BE-9051",
    "ext": "",
    "address2": "",
    "address1": "Kortrijksesteenweg 1095",
    "dept": "Engineering",
    "userId": 7,
    "firstName": "test",
    "phone": "",
    "middleName": "a",
    "position": "Engineer",
    "username": "testUser",
    "type": "Global Administrator",
    "status": "Active",
    "primaryGroup": 6,
    "groups": [
      0,
      6,
      8
    ]
  }
 ]

Classes

UserManager_GET