Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

1. Creating an API Token


To create an API token navigate to My settings > API tokens. Click create new token and choose the UNIQUE label.

Multimedia
name1CreatingToken.mov
Note

Remember to save the returned token or you will lose access to it forever.

2. Admin API Token management

Jira Admins have access to the all users' API tokens of all users. Admin can invalidate all tokens of one user or individual token.

Multimedia
name2AdminTokenView.mov

3. Invalidating API Token

API Token may be invalidated. Invalidation of API token prevents further use of the API Token.

Multimedia
name3InvalidateToken.mov

4. Obtaining base URL

You have to obtain JWT from any request to /cloudmanager made from your JiraUsing endpoint:
https://cloud.softwareplant.com/cloudmanager/bigpicture/where-am-i
With Authorization header set to:
APIToken <obtainedApiToken>Will <obtainedApiToken>Will return location e.g. https://cloud.softwareplant.com/bigpicture/jiracloud/101

Multimedia
name4WhereAmIAPIToken.mov

Curl example:

Code Block
curl --location --request GET 'https://cloud.softwareplant.com/cloudmanager/bigpicture/where-am-i' \

--header 'Authorization: APIToken <<Your API Token>>'

...

You can create full URL using baseUrl you obtained in 4. by combining it with actual application endpoint
https://cloud.softwareplant.com/bigpicture/jiracloud/101/rest/system/user/current/profile/data

Multimedia
name5UseAPIToken.mov

Curl example:

Code Block
curl --location --request GET 'https://cloud.softwareplant.com/bigpicture/jiracloud/108/rest/system/user/current/profile/data' \

--header 'Authorization: APIToken <<Your Api Token>>'

Best practices:

  • It's highly suggested to create a dedicated Jira user for integration purposes. Add Application access to this user and generate API tokens using him.