Using REST API integrations

Abstract

How to integrate with Tempo public REST APIs

In order to integrate with the Tempo Public APIs, you will need a private user token or an OAuth Token, see Using OAuth 2.0 Authentication. You can create one or more tokens and define the access scope for each token.

The API Integration overview shows a list of all your API tokens, active and expired. The status of each token is displayed along with its expiration date. You can rename, regenerate, and delete current tokens.

The API Integration overview page shows a list of all your API tokens
Creating a New Token

Create a new token with full or restricted access to Tempo APIs. Note that full access tokens apply to current scopes/namespaces. The token will not automatically grant access to scopes/namespaces that are added after the token is created.

To create a user API token:

  1. Select Settings Settings.png in the Tempo sidebar.

  2. Under Data Access, select API Integration.

  3. Click New Token at the upper-right.

  4. In the New Token form, define the access token.

    • Name - Enter a descriptive name for the token.

    • Expiry - Set the expiration time for the token. By default, the access token is valid for 30 days, but you can select a longer expiration time up to maximum of 5000 days.

    • Define the access scope for the token. You can either have full access to all APIs, or you can define custom access for this token.

  5. When you are done, click Confirm.

  6. The token is created and displayed. We only show your access token when you first generate it in order to make your account more secure. You can click Copy.png to copy the token. If you forget to copy the token, you can regenerate it. This will invalidate the existing token, see Regenerating Tokens below.

  7. When you are done, click Close.

View Access vs. Manage Access

Scopes can authorize view or manage access:

  • View access gives permission to make GET requests within the scope.

  • Manage access gives permission to make any request within the scope, that is, GET, PUT, POST, and DELETE.

Scopes and APIs

Note

You can find the complete Tempo for Jira Cloud API documentation here.

Available scopes and the API namespaces they give access to include the following:

  • Worklogs scope

    • Worklogs

    • Work Attributes

  • Teams scope

    • Roles

    • Teams

    • Links

    • Memberships

  • Schemes scope

    • Workload Schemes

    • Holiday Schemes

    • User Schedule

  • Plans scope

    • Plans

    • Programs

  • Periods scope

    • Periods

  • Approvals scope

    • Timesheet Approvals

  • Accounts scope

    • Accounts

    • Categories

    • Category Types

    • Links

    • Customers

  • Cost Tracker scope

    • Projects

Regenerating Tokens

As long as a token has not expired, it is possible to regenerate the token. The regenerated token will invalidate the current token and generate a new one with the same access as the previous token. This will revoke access for all integrations that were previously using the token.

To regenerate a token:

  1. In the token overview, click ellipsis.png for the token you want to edit, and then select Regenerate.

  2. Click Generate to create a new token.

  3. Copy the token, and then close the pop-up dialog.

Editing Tokens

Editing the token only allows you to edit the name of the token to give it a more descriptive name. It does not give you the possibility of modifying the access.

  1. In the token overview, click ellipsis.png for the token you want to edit, and then select Edit.

  2. Enter the new name.

  3. Click Confirm.

Notice

It is not possible to change the scope for a token. If you created a token with the wrong access, you need to create a new token.

Deleting Tokens

You can delete an existing access token at any time. Deleting a token revokes all access for integrations using the token.

  1. In the token overview, click ellipsis.png for the relevant token, and then select Delete.

  2. Click Delete in the confirmation pop-up dialog.