Page tree
Skip to end of metadata
Go to start of metadata

The API Settings page allows you to create and edit JWT tokens that can be used to get Time in Status reports via REST API.

Documentation about the format of REST calls can be found in TiS Cloud - REST Reporting.


Warning

The tokens listed in API Settings page are used for authentication while accessing your Jira data through Time in Status. The tokens serve the same function as your Jira username and password.

You MUST keep the tokens safe.

If you suspect that the safety of a token is compromised, you can use API Settings page to deactivate the token.

Sometimes Atlassian rolls out updates gradually or an updated app requires a confirmation from Jira Admin.

If you can see other Time in status admin pages but can't see the API Settings page under Jira Settings, then you can force an update by going to Manage Apps page of your Jira. You will probably see an Update button under Time in Status. Click it and refresh the page. You should now see the API Settings page.



Token records contain these fields:

FieldDescription
Active

Sets whether a token is active or inactive.

Inactive tokens will not be accepted by the system for authentication so you can deavtivate a token if you think it is compromised.

User

You select the user with which the token will be authenticated with.

The REST report requests sent with this token will be using the selected user's permissions on Jira.

This field is set while creating the token and cannot be changed later.

Created At

The date and time that the token was created.

Set by system and cannot be changed.

Expires At

The expiry date of the token.

Expired tokens will not be accepted by the system for authentication. 

This field is mandatory but can also be set to a date far in the future (ex: 31 Dec 2099) so in practice the set date can have no effect.

The expiry date can be changed after creating the token. If you change the date to a point earlier than the current date, the token will simply not be accepted by the system.

Token

This is the actual text representation of the token which consists of a very long string of alphanumerical symbols.

You can get the token directly from the textbox or use the button next to the textbox to copy to clipboard.

You are expected to provide this token as part of your REST call as described in TiS Cloud - REST Reporting.

NotesThis is the free format notes area for the token. You can put any text here that will make it easier for you to manage your tokens.


Editing a Token

You can edit an existing token using the Edit button in the Actions column.

Active/Inactive, Expiry Date and Notes fields can be changed after the token is created.

Deleting a Token

Use can delete an existing token using the Delete button in the Actions column.

Please note that once a token is deleted, it is gone for good and cannot be recovered.








  • No labels