REST API - Get User Request
9 min
/api/v1/users/{userid} description retrieves the user with the specified user id url structure \[blueprint uri]/api/v1/users/{userid} userid defines the id of the user supported methods head docid\ eqnd3zptd6dwf3go3ufox get docid 7hm2r py7e84xk2msf11b http status codes 200 ok 201 successfully created 206 partial content 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 404 notfound item is not found in the project for example, this error can occur when artifact not found artifact type not found project not found alm target not found change summary job not found user does not have edit permissions for this artifact, project or alm target 409 conflict reason for failure can be found in the response body additional information may also be found in the log 411 length required if the content length header is missing in the request 413 request entity too large if the provided file size is larger than allowed 415 unsupported media type if the provided media type is not of mime multipart content "form data " 416 request range not satisfiable if offset points to a part of a collection that is not available 500 internal server error 501 not implemented examples xml example request uri https //production blueprintcloud com/api/v1/users/125? response header {'content length' '332', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 14 59 22 gmt', 'expires' ' 1', 'content type' 'application/xml; charset=utf 8', 'server' 'blueprint'} response body \<?xml version="1 0" ?>\<user xmlns="http //www blueprintsys com/blueprint/api/v1" xmlns\ i="http //www w3 org/2001/xmlschema instance"> \<displayname>api documentation user\</displayname> \<firstname>api\</firstname> \<groups> \<group> \<id>75\</id> \<name>api authors\</name> \</group> \</groups> \<id>125\</id> \<lastname>documentation\</lastname> \<name>api docs user\</name>\</user> json example request uri https //production blueprintcloud com/api/v1/users/125? response header {'content length' '205', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 11 49 50 gmt', 'expires' ' 1', 'content type' 'application/json; charset=utf 8', 'server' 'blueprint'} response body { "displayname" "api documentation user", "name" "api docs user", "firstname" "api", "lastname" "documentation", "groups" \[ { "projectid" null, "type" "group", "id" 75, "name" "api authors" } ], "type" "user", "id" 125}