All REST requests shown in this document require authorization.

Authorization is established through the use of tisjwt tokens. For details about getting tisjwt tokens please see TiS Cloud - API Settings.

You can either provide this token as a query parameter or include it in the HTTP request header.

Providing a tisjwt token in request header

The tisjwt token can be provided as part of the request header as...

keyvaluevalue sample
AuthorizationTISJWT <tsjwt>

TISJWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJjb20ub2JThisIsaFakeJWTltZS1pbi1zdGF0dXMiLCJzdWIiOiI1NTcwNTg6MGQ5

MDM3N2YtMTNlZS00MzEzLTlmNjYtMDA1NTVhYTI4MGUzIiwiY2xpZW50S2V5IjoiMThlNWViY2MtM2QyZC0zNzg5LWExODAtYzQ5NzgwO

WM1ZTdlIiwiaXNzIjoiY29tLm9ic3MucGx1Z2luLnRpbWUtaW4tc3RhdHVzIiwiZXhwIjo0MTAyNDQ0NzQwLCJpYXQiOjE1ODMzMDgzMzB9.Nl

inm0tNgM9pSk0Dd4FeNZVzLHAPabgfDEcVxdWuJGE

This is the recommended way for authorization.


Providing a tisjwt token as a query parameter

The tisjwt token can be provided in the query URL as a query parameter with the same name as shown below.

This use is not recommended to be used with production tisjwt tokens since it will include your tisjwt token in the URL and thus expose it in various access logs and request histories.

Example

https://tis.obss.io/rest/export/status?tisjwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJjb20ub2JThisIsaFakeJWTltZS1pbi1zdGF0dXMiLCJzdWIiOiI1NTcwNTg6MGQ5MDM3N2YtMTNl

ZS00MzEzLTlmNjYtMDA1NTVhYTI4MGUzIiwiY2xpZW50S2V5IjoiMThlNWViY2MtM2QyZC0zNzg5LWExODAtYzQ5NzgwOWM1ZTdlIiwiaXNzIjoiY29tLm9ic3MucGx1Z2luLnRpbWUtaW4tc3RhdHVzIi

wiZXhwIjo0MTAyNDQ0NzQwLCJpYXQiOjE1ODMzMDgzMzB9.Nlinm0tNgM9pSk0Dd4FeNZVzLHAPabgfDEcVxdWuJGE


Responses

All endpoints will return the following responses on tisjwt related errors.

No TisJwt

HTTP 401

When you do not provide a tisjwt parameter with the request or the parameter is empty.

{
    "status": 401,
    "message": "Unauthorized access",
    "messages": [
        "tisjwt is required for authentication."
    ],
    "pluginVersion": "2.0.0.1",
    "time": "2022-06-15 10:50:58 +0000"
}

Invalid TisJwt

HTTP 401

When the tisjwt parameter contains an invalid token. A token is invalid when it is malformed, not active or has expired.

{
    "status": 401,
    "message": "Unauthorized access",
    "messages": [
        "tisjwt is invalid. Please make sure that you have supplied a valid tisjwt token that is active and has not expired."
    ],
    "pluginVersion": "2.0.0.1",
    "time": "2022-06-15 10:53:55 +0000"
}

Invalid License

HTTP 401

When the Timepiece license on your Jira Cloud instance is not valid.

{
    "status": 401,
    "message": "Unauthorized access",
    "messages": [
        "License is not valid."
    ],
    "pluginVersion": "1.18.0.1",
    "time": "2020-03-19 05:36:42"
}

Invalid User

HTTP 401

When the user associated with the tisjwt token is inactive on your instance.

{
    "status": 401,
    "message": "Unauthorized access",
    "messages": [
        "User is not an active Jira user."
    ],
    "pluginVersion": "1.18.0.1",
    "time": "2020-03-19 05:36:42"
}
  • No labels

© 2012-2015 Copyright OBSS