Difference between revisions of "API Delete User"
IVSWikiBlue (talk | contribs) (Created page with "This API call will delete an existing user. ===Resource URL=== <pre>http://valt.example.com/api/v3/admin/users/{userid}/delete</pre> ''Replace {userid} with the actual id num...") |
IVSWikiBlue (talk | contribs) |
||
| Line 47: | Line 47: | ||
==Examples== | ==Examples== | ||
===Request=== | ===Request=== | ||
| − | <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users/52/delete?access_token= | + | <pre>https://ivstest1.ad.ipivs.com/api/v3/admin/users/52/delete?access_token=exampletoken</pre> |
===Successful Response=== | ===Successful Response=== | ||
Latest revision as of 15:32, 18 September 2026
This API call will delete an existing user.
Contents
Resource URL
http://valt.example.com/api/v3/admin/users/{userid}/delete
Replace {userid} with the actual id number of the user. Users are numbered sequentially when added to VALT.
Resource Information
| Method | POST |
| Response Type | JSON |
| Authentication Required | Yes |
Parameters
No parameters are required for this API call.
Response
| Code | Reason |
|---|---|
| 200 | Request Successful |
| 401 | Unauthorized |
| 404 | User Not Found |
| data | |
|---|---|
| message | Deleted |
Examples
Request
https://ivstest1.ad.ipivs.com/api/v3/admin/users/52/delete?access_token=exampletoken
Successful Response
{
"data":{
"message": "Deleted"
}
}
Failure Response
{
"error":{
"code": 404
}
}
