REST API - Authenticate Request

/authentication/v1/loginEx

Description

Generates an authentication token for the specified user.

Blueprint exclusively supports Basic Authentication for the submission of credentials.  Thereafter, a proprietary token is used. To obtain a token, you must provide an Authorization header with Basic scheme. Refer to the Quick Start Example for more information.

URL Structure

[Blueprint_URI]/authentication/v1/loginEx

Supported Methods

• GET

Notes

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 Examples

Request URI

https://production.blueprintcloud.com/authentication/v1/login

Response Header

{'content-length': '313', 'x-xss-protection': '1; mode=block', 'blueprinttokenexpirydate': 'Thu, 28 Nov 2013 17:47:20 GMT', 'x-content-type-options': 'nosniff', 'expires': '-1', 'server': 'Blueprint', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Thu, 28 Nov 2013 17:17:20 GMT', 'x-frame-options': 'deny', 'content-type': 'application/xml; charset=utf-8', 'authorization': 'BlueprintToken c5vEipeBiH0mng0pIrnTj+dVSHgWzLGm3XE/OBk8JJ67D2lQnhQneAeKi0GLoLw+1qDQAaCQg0V0Hc7qcmp+FHbkaHSK6/yrzFl0MNz64VHXc4uTJjpe91XFhL1B+yBBeXRVtydzVgw4zrjRxT5qYwosGr/jfi9hR82khFYIolnzzUeQ+wUj95337u3hDtyINqGdY2Qj/IlEzaToo9dQajX4fZoH3HKOPG/BtH1JXwc='}

Response Body

<?xml version="1.0" encoding="UTF-8"?>
<AuthenticationInfo xmlns="http://www.blueprintsys.com/blueprint/api/v1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">

<Token>XEjna6FKp734EH0fyJ3T0rIeVuBqejQWZAULgRzsz4IpfPKXrZYbk6sGijD+xRJk1grgAe7lbBA6768BotXCWVTfgDdhyZiV7dsGIeu4UXJ55SuWDpnsW4uViCbSdENdqD5b7JOKES98KfdDfFK+chGMUBw3uN6I20nKoehJ8KWTMz+4oO77yMrtknZjqoTbto5wrfnNND+IndZk0Lzqu7RMvHdHtjPxkbHeZ1TcaOA=</Token>
   <TokenExpirationTime>2013-12-05T14:55:14.9131132Z</TokenExpirationTime>
   <UserDisplayName>Default Instance Admin</UserDisplayName>
   <UserId>1</UserId>
   <UserLicense>Author</UserLicense>
   <UserName>admin</UserName>
</AuthenticationInfo>

JSON Example

Request URI

https://production.blueprintcloud.com/authentication/v1/login

Response Header

{'content-length': '238', 'x-xss-protection': '1; mode=block', 'blueprinttokenexpirydate': 'Thu, 28 Nov 2013 17:20:34 GMT', 'x-content-type-options': 'nosniff', 'expires': '-1', 'server': 'Blueprint', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Thu, 28 Nov 2013 16:50:34 GMT', 'x-frame-options': 'deny', 'content-type': 'application/json; charset=utf-8', 'authorization': 'BlueprintToken M6Uf+rS0WsqD89d2Rf+nw18g/RPoC4T01Iecy0FxK+vJaoYJErY3Dc9zGuk08wQq93yYkx+v/j7S1KooxYY/SE7/e7XGAYV5A5AABtw0hH/lbvtZcvjdaDBOt91faamSQFuRz5PVQHHnvktmais92QdFn/Eu8CWRYbLazMHEcVTT9HNMENVDLvUJl33+WIKw9XticLuiIogQh9rgRxdoWyBPvEGtqNUWYFuNC81mF0o='}

Response Body

{
    "Token": "dQ5eXjxQ2TbpJTgTo0EknQXwJceOPfBVVGQNiPB6aRmdIc08AWwxEnfpXZ1N/kO4W8aB+uSccy3bs3IDmYIcfBdnuH7YYsSl41BuiM1+4oCNPKgKhb6YuZy83018sOtMjIExLzdPG5422BW/JwRtpwPbRhFzXiu9aoTgH4wB9HkS/XWhl3Ki5IDgABT9OFMwcSviwhSEjMOTHPEkJeEls5ophGkK4HTR2htZDSZdX8E=",
    "TokenExpirationTime": "2013-12-05T14:54:49.1166224Z",
    "UserName": "admin",
    "UserDisplayName": "Default Instance Admin",
    "UserId": 1,
    "UserLicense": "Author"
}