REST API - Get User Request

/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

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, Traces, Offset or Limit parameters.
    • A required value has not been provided.
    • If you are submitting a POST or PATCH 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
}