UserManager_DELETE
Removes users
Defined in: userManager.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
UserManager_DELETE(users, pretty)
DELETE /wf/restapi/v2/admin/userManager: Removes users from MediaBeacon
|
Class Detail
UserManager_DELETE(users, pretty)
DELETE /wf/restapi/v2/admin/userManager: Removes users from MediaBeacon
- Parameters:
- users
- An array of user objects to remove. These objects can have the same structure as collected from UserManager_GET, but only require "userId" or "username".
- pretty Optional, Default: false
- format the response to be human readable?
DELETE /wf/restapi/v2/admin/userManager
Body form-data:
users =
[
{
"lastName": "user_last",
"substitutionMap": {},
"country": "USA",
"city": "Minneapolis",
"company": "",
"state": "Minnesota",
"email": "",
"zip": "55401",
"ext": "",
"address2": "",
"address1": "",
"dept": "Engineering",
"userId": 3,
"firstName": "user",
"phone": "",
"middleName": "",
"position": "vertical",
"username": "user 1",
"type": "Global Administrator",
"status": "Active",
"primaryGroup": 6,
"groups": [
0,
6
]
},
{
"username": "user_2"
},
{
"userId": "5"
}
]
Response:
[
{
"lastName": "user_last",
"country": "USA",
"city": "Minneapolis",
"company": "",
"state": "Minnesota",
"email": "",
"zip": "55401",
"ext": "",
"address2": "",
"address1": "",
"dept": "Engineering",
"userId": 3,
"firstName": "user",
"phone": "",
"middleName": "",
"position": "",
"username": "user 1",
"type": null,
"status": "",
"groups": []
},
{
"lastName": "",
"country": "",
"city": "",
"company": "",
"state": "",
"email": "",
"zip": "",
"ext": "",
"address2": "",
"address1": "",
"dept": "",
"userId": 4,
"firstName": "",
"phone": "",
"middleName": "",
"position": "",
"username": "user_2",
"type": null,
"status": "",
"groups": []
},
{
"userId": 5,
"username": "removebyid",
"type": null,
"status": "",
"groups": []
}
]