REST API - Delete User Request
8 min
/api/v1/users description deletes all specified users url structure \[blueprint uri]/api/v1/users supported methods delete docid\ vnmdtbrg59iwf4suh4zey http status codes 200 ok 207 partially successful some of the users could not be created refer to the codes in the response for the reason for each unsuccessfully added user 1192 a required value is missing or invalid username, display name, first name, last name, password 1193 the user was created, but could not be added to a group 1194 the assigned instance administrator role does not exist 400 bad request this error can occur for a variety of reasons at least one uri or request body parameter is invalid, such as one of the filter docid\ sv9gjverxczcgqdn28j7u , traces, offset or limit parameters a required value has not been provided if you are submitting a post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui request and have not added the x http method override parameter to your request header 401 unauthorized the blueprint token is missing, invalid or expired 403 forbidden the applicable permissions are needed for example, this error can occur when an author or collaborate license is needed for access comment permissions are needed on the artifact edit permissions are needed on the change summary job 409 conflict reason for failure can be found in the response body additional information may also be found in the log examples xml example request uri https //production blueprintcloud com/api/v1/users request body \<?xml version="1 0" ?>\<users xmlns="http //www blueprintsys com/blueprint/api/v1"> \<user> \<displayname>quaaade\</displayname> \<firstname>douglas\</firstname> \<lastname>quade\</lastname> \<name>dquade\</name> \<password>@quaaade#1\</password> \</user>\</users> response body language php template \<useraddresults xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<useraddresult> \<message>user has been successfully deleted \</message> \<resultcode>200\</resultcode> \<user> \<email>dquade2084\@dev recall com\</email> \<department>devops\</department> \<displayname>quaaade\</displayname> \<enabled>false\</enabled> \<firstname>douglas\</firstname> \<groups /> \<id>3754\</id> \<lastname>quade\</lastname> \<name>dquade\</name> \<title>engineer\</title> \</user> \</useraddresult>\</useraddresults> json example request uri https //production blueprintcloud com/api/v1/users request body \[ "fanvid", "noviseth"] response body \[ { "user" { "type" "user", "id" 22, "name" "fanvid", "displayname" "david", "firstname" "david", "lastname" "gao", "title" "tester", "department" "rd", "enabled" true, "email" "wxzalz3rsk\@flqapzon90 com" }, "message" "user has been successfully deleted ", "resultcode" 200 }, { "user" { "type" "user", "id" 31, "name" "noviseth", "displayname" "novina sethuraman", "firstname" "novina", "lastname" "sethuraman", "title" "tester", "department" "rd", "enabled" true, "email" "4slh4fqosa\@m7do1b7ob0 com" }, "message" "user has been successfully deleted ", "resultcode" 200 }]