Delete a user
This API is used to delete an existing user.
Example API call
/servlets3/wietmsd?id=1459755986251&book=s1000d_bike_41&collection=default&target=admin&action=delete_users&userids=n_1459755986251_1459760602455
Parameters
| Parameter | Description |
|---|---|
target | admin |
action | delete_user |
id | A session ID that is valid for this collection and publication combination. |
userids | IDs of the users to be deleted |
book | The name of the publication, such as s1000d_bike_41. |
collection | The name of the collection that the publication is registered in, such as default. |
Returns
- On success
-
Returns a list of users that doesn't include the specified user. In this example, a user with the name
newUseris deleted:<USERS> <USERBODY> <USERITEM STATUS="" USER_ID="admin"> <LOGIN>admin</LOGIN> <GROUP>ADMINISTRATOR</GROUP> <LAST_NAME/> <FIRST_NAME/> <COMPANY/> <COMPCODE/> </USERITEM> <USERITEM STATUS="" USER_ID="n_1459755986251_1459759113360"> <LOGIN>newUser</LOGIN> <GROUP>EDITOR</GROUP> <LAST_NAME>newUser</LAST_NAME> <FIRST_NAME>newUser</FIRST_NAME> <COMPANY/> <COMPCODE/> </USERITEM> <USERITEM STATUS="" USER_ID="guest"> <LOGIN>guest</LOGIN> <GROUP>GUEST</GROUP> <LAST_NAME/> <FIRST_NAME/> <COMPANY/> <COMPCODE/> </USERITEM> </USERBODY> </USERS> - On failure
-
The user is not deleted. Returns a list of users that includes the specified user. In this example, the user with the name
newUseris not deleted.<USERS> <USERBODY> <USERITEM STATUS="" USER_ID="admin"> <LOGIN>admin</LOGIN> <GROUP>ADMINISTRATOR</GROUP> <LAST_NAME/> <FIRST_NAME/> <COMPANY/> <COMPCODE/> </USERITEM> <USERITEM STATUS="" USER_ID="n_1459755986251_1459759113360"> <LOGIN>newUser</LOGIN> <GROUP>EDITOR</GROUP> <LAST_NAME>newUser</LAST_NAME> <FIRST_NAME>newUser</FIRST_NAME> <COMPANY/> <COMPCODE/> </USERITEM> <USERITEM STATUS="" USER_ID="guest"> <LOGIN>guest</LOGIN> <GROUP>GUEST</GROUP> <LAST_NAME/> <FIRST_NAME/> <COMPANY/> <COMPCODE/> </USERITEM> </USERBODY> </USERS>