API Token AuthenticationAPI Token Authentication
Try For Free

REST API

The API Token Authentication app currently provides a few REST API endpoints. Please find below a summary of what can be done already.

Create a new token 

Create a new token by providing its description as follows. The response will contain the token automatically generated.

  1. curl -v -u user:password -d '{"tokenDescription":"<enter-your-token-description-here>"}' POST https://<your-jira-or-confluence>/rest/de.resolution.apitokenauth/latest/user/token --header "Content-Type: application/json"

Update a token description

  1. curl -v -u user:password -d '{"tokenDescription":"Updated token description"}' -X PATCH https://<your-jira-or-confluence>/rest/de.resolution.apitokenauth/latest/user/token/<token-id> --header "Content-Type: application/json"

List all tokens

To get an overview of what tokens you've added for your user and to grab an id of one to update or delete it, execute the request below.
You may omit the pipe symbol and python command at the end, it is just for beautifying the JSON response.

  1. curl -v -u user:password GET https://<your-jira-or-confluence>/rest/de.resolution.apitokenauth/latest/user/token/ | python -mjson.tool

which produces output like:

  1. [
  2. {
  3. "created": 1573814077364,
  4. "description": "Automation token",
  5. "id": 4,
  6. "lastAccessed": 1573814464012
  7. }
  8. ]

Delete a token 

Grab a token ID retrieved with the previous call and put it to end of the call: 

  1. curl -v -u user:password -X DELETE https://<your-jira-or-confluence>/rest/de.resolution.apitokenauth/latest/user/token/<token-id>

Delete all tokens for a user 

This call will work for sysadmins only and otherwise throw 403. Please note that the user key is passed, which is different than the name *.  

  1. curl -v -u admin:password -X DELETE https://<your-jira-or-confluence>/rest/de.resolution.apitokenauth/latest/user/token/deleteAllFor/<user-key-not-user-name>


Get User Key for a User

* you can get a user's key by  using the REST API as an admin

The result will contain a key or userKey field (Jira or Confluence)

Jira

  1. curl -v -u admin:password GET https://<your-jira>/rest/api/2/user?username=some.username | python -mjson.tool
  4. {
  5. "active": true,
  6. "applicationRoles": {
  7. "items": [],
  8. "size": 1
  9. },
  10. "avatarUrls": {
  11. "16x16": "https://www.gravatar.com/avatar/9c7da4947106c84fe2c18c1a48747c54?d=mm&s=16",
  12. "24x24": "https://www.gravatar.com/avatar/9c7da4947106c84fe2c18c1a48747c54?d=mm&s=24",
  13. "32x32": "https://www.gravatar.com/avatar/9c7da4947106c84fe2c18c1a48747c54?d=mm&s=32",
  14. "48x48": "https://www.gravatar.com/avatar/9c7da4947106c84fe2c18c1a48747c54?d=mm&s=48"
  15. },
  16. "displayName": "Some User",
  17. "emailAddress": "some@user.com",
  18. "expand": "groups,applicationRoles",
  19. "groups": {
  20. "items": [],
  21. "size": 1
  22. },
  23. "key": "JIRAUSER10100",
  24. "locale": "en_US",
  25. "name": "Some User",
  26. "self": "https://<your-jira>/rest/api/2/user?username=some.username",
  27. "timeZone": "GMT"
  28. }

Confluence

  1. curl -v -u admin:password GET https://<your-confluence>/rest/api/user?username=some.username | python -mjson.tool
  3. {
  4. "_expandable": {
  5. "status": ""
  6. },
  7. "_links": {
  8. "base": "https://<your-confluence>",
  9. "context": "",
  10. "self": "https://<your-confluence>/rest/api/user?key=e4fc80a46ebbdf4c016fa42e69be01f8"
  11. },
  12. "displayName": "some.username",
  13. "profilePicture": {
  14. "height": 48,
  15. "isDefault": true,
  16. "path": "/images/icons/profilepics/default.svg",
  17. "width": 48
  18. },
  19. "type": "known",
  20. "userKey": "e4fc80a46ebbdf4c016fa42e69be01f8",
  21. "username": "some.username"
  22. }