API Token AuthenticationAPI Token Authentication
Try For Free

Using Tokens - Examples

The Token use itself is very simple - in the place where you would usually use the password, you just use the Token itself.
Nevertheless here are some examples in different languages.

The Example

Jira

The API call we'll use as an example in Jira is

  1. https://<YOUR_JIRA_BASEURL>/rest/api/2/myself


This gives you profile information about the currently logged-in User (in our case the User associated with the token).

A result looks like this:

  1. {
  2. "self": "http://www.example.com/jira/rest/api/2/user?username=fred",
  3. "name": "fred",
  4. "emailAddress": "fred@example.com",
  5. "avatarUrls": {
  6. "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred",
  7. "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred",
  8. "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred",
  9. "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred"
  10. },
  11. "displayName": "Fred F. User",
  12. "active": true,
  13. "timeZone": "Australia/Sydney",
  14. "groups": {
  15. "size": 3,
  16. "items": [
  17. {
  18. "name": "jira-user",
  19. "self": "http://www.example.com/jira/rest/api/2/group?groupname=jira-user"
  20. },
  21. {
  22. "name": "jira-admin",
  23. "self": "http://www.example.com/jira/rest/api/2/group?groupname=jira-admin"
  24. },
  25. {
  26. "name": "important",
  27. "self": "http://www.example.com/jira/rest/api/2/group?groupname=important"
  28. }
  29. ]
  30. },
  31. "applicationRoles": {
  32. "size": 1,
  33. "items": []
  34. },
  35. "expand": "groups,applicationRoles"
  36. }

More details in the Atlassian Jira REST Documentation: https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/#api/2/myself

Confluence

For Confluence the respective call would be:

  1. http://<YOUR_CONFLUENCE_BASEURL>/rest/api/user/current


This gives you profile information about the currently logged-in User (in our case the User associated with the token).

A result looks like this

  1. {
  2. "type": "known",
  3. "username": "jsmith",
  4. "userKey": "402880824ff933a4014ff9345d7c0002",
  5. "profilePicture": {
  6. "path": "/wiki/relative/avatar.png",
  7. "width": 48,
  8. "height": 48,
  9. "isDefault": true
  10. },
  11. "displayName": "Joe Smith",
  12. "_links": {
  13. "base": "http://myhost:8080/confluence",
  14. "context": "/confluence",
  15. "self": "http://myhost:8080/confluence/rest/experimental/user?key=402880824ff933a4014ff9345d7c0002"
  16. },
  17. "_expandable": {
  18. "status": ""
  19. }
  20. }

More details in the Atlassian Confluence REST Documentation: https://docs.atlassian.com/atlassian-confluence/REST/6.6.0/#user-getCurrent

Bearer Auth header

Since version 1.7.0 you can also use a token as bearer token.
The difference is that instead passing type "Basic" you need to specify "Bearer" and you can omit the username and pass the token directly.

  1. Authorization: Bearer <yourToken>

cURL Example

  1. curl "https://YOUR_JIRA_BASEURL/rest/api/2/myself" \
  2. -H "Authorization: Bearer <YOUR_API_TOKEN>"


Basic Auth header

Most of the following examples will use the basic auth header. The Basic auth header looks like this:

  1. Authorization: Basic dXNlckBleGFtcGxlLmNvbTpzZWNyZXQ=

Its value is simply a Base64-encoded representation of "username:password", in our case that would be "<username>:<your-api-token> (like when you place credentials in the URL directly).
There are a variety of website to generate this manually for Lab use like: https://www.blitter.se/utils/basic-authentication-header-generator/

Here are also many examples for different Languages: https://gist.github.com/brandonmwest/a2632d0a65088a20c00a

cURL Example

  1. curl "https://YOUR_JIRA_BASEURL/rest/api/2/myself" \
  2. -u '<USERNAME>:<YOUR_API_TOKEN>'

Ruby

Replace in the below:

  1. require 'net/http'
  2. require 'net/https'
  4. # SAML (GET )
  5. def send_request
  6. uri = URI('https://YOUR_JIRA_BASEURL/rest/api/2/myself')
  8. # Create client
  9. http = Net::HTTP.new(uri.host, uri.port)
  10. http.use_ssl = true
  11. http.verify_mode = OpenSSL::SSL::VERIFY_PEER
  13. # Create Request
  14. req = Net::HTTP::Get.new(uri)
  15. # Add headers
  16. req.add_field "Authorization", "Basic <YOUR_BASIC_AUTH_HEADER>"
  18. # Fetch Request
  19. res = http.request(req)
  20. puts "Response HTTP Status Code: #{res.code}"
  21. puts "Response HTTP Response Body: #{res.body}"
  22. rescue StandardError => e
  23. puts "HTTP Request failed (#{e.message})"
  24. end


Python

Replace in the below:

  1. # Install the Python Requests library:
  2. # `pip install requests`
  4. import requests
  7. def send_request():
  8. # SAML
  9. # GET https://YOUR_JIRA_BASEURL/rest/api/2/myself
  11. try:
  12. response = requests.get(
  13. url="https://YOUR_JIRA_BASEURL/rest/api/2/myself",
  14. headers={
  15. "Authorization": "Basic <YOUR_BASIC_AUTH_HEADER>",
  16. },
  17. )
  18. print('Response HTTP Status Code: {status_code}'.format(
  19. status_code=response.status_code))
  20. print('Response HTTP Response Body: {content}'.format(
  21. content=response.content))
  22. except requests.exceptions.RequestException:
  23. print('HTTP Request failed')


node.js

Replace in the below:

  1. // request
  2. (function(callback) {
  3. 'use strict';
  5. const httpTransport = require('https');
  6. const responseEncoding = 'utf8';
  7. const httpOptions = {
  8. hostname: 'YOUR_JIRA_BASEURL',
  9. port: '443',
  10. path: '/rest/api/2/myself',
  11. method: 'GET',
  12. headers: {"Authorization":"Basic <YOUR_BASIC_AUTH_HEADER>"}
  13. };
  14. httpOptions.headers['User-Agent'] = 'node ' + process.version;
  16. // Using Basic Auth {"username":"<USERNAME>","password":"<YOUR_API_TOKEN>"}
  18. const request = httpTransport.request(httpOptions, (res) => {
  19. let responseBufs = [];
  20. let responseStr = '';
  22. res.on('data', (chunk) => {
  23. if (Buffer.isBuffer(chunk)) {
  24. responseBufs.push(chunk);
  25. }
  26. else {
  27. responseStr = responseStr + chunk;
  28. }
  29. }).on('end', () => {
  30. responseStr = responseBufs.length > 0 ?
  31. Buffer.concat(responseBufs).toString(responseEncoding) : responseStr;
  33. callback(null, res.statusCode, res.headers, responseStr);
  34. });
  36. })
  37. .setTimeout(0)
  38. .on('error', (error) => {
  39. callback(error);
  40. });
  41. request.write("")
  42. request.end();
  45. })((error, statusCode, headers, body) => {
  46. console.log('ERROR:', error);
  47. console.log('STATUS:', statusCode);
  48. console.log('HEADERS:', JSON.stringify(headers));
  49. console.log('BODY:', body);
  50. });


Java

Replace in the below:

  1. public class SendRequest
  2. {
  3. public static void main(String[] args) {
  4. sendRequest();
  5. }
  7. private static void sendRequest() {
  9. // SAML (GET )
  11. try {
  13. // Create request
  14. Content content = Request.Get("https://YOUR_JIRA_BASEURL/rest/api/2/myself")
  16. // Add headers
  17. .addHeader("Authorization", "Basic <YOUR_BASIC_AUTH_HEADER>")
  19. // Fetch request and return content
  20. .execute().returnContent();
  22. // Print content
  23. System.out.println(content);
  24. }
  25. catch (IOException e) { System.out.println(e); }
  26. }
  27. }


PHP

Replace in the below:

  1. <?php
  3. // get cURL resource
  4. $ch = curl_init();
  6. // set url
  7. curl_setopt($ch, CURLOPT_URL, 'https://YOUR_JIRA_BASEURL/rest/api/2/myself');
  9. // set method
  10. curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
  12. // return the transfer as a string
  13. curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
  15. // set headers
  16. curl_setopt($ch, CURLOPT_HTTPHEADER, [
  17. 'Authorization: Basic <YOUR_BASIC_AUTH_HEADER>',
  18. ]);
  20. // send the request and save response to $response
  21. $response = curl_exec($ch);
  23. // stop if fails
  24. if (!$response) {
  25. die('Error: "' . curl_error($ch) . '" - Code: ' . curl_errno($ch));
  26. }
  28. echo 'HTTP Status Code: ' . curl_getinfo($ch, CURLINFO_HTTP_CODE) . PHP_EOL;
  29. echo 'Response Body: ' . $response . PHP_EOL;
  31. // close curl resource to free up system resources
  32. curl_close($ch);


GO

Replace in the below:

  1. package main
  3. import (
  4. "fmt"
  5. "io/ioutil"
  6. "net/http"
  7. )
  9. func sendRequest() {
  10. // Request (GET https://YOUR_JIRA_BASEURL/rest/api/2/myself)
  12. // Create client
  13. client := &http.Client{}
  15. // Create request
  16. req, err := http.NewRequest("GET", "https://YOUR_JIRA_BASEURL/rest/api/2/myself", nil)
  18. // Headers
  19. req.Header.Add("Authorization", "Basic <YOUR_BASIC_AUTH_HEADER>")
  21. // Fetch Request
  22. resp, err := client.Do(req)
  24. if err != nil {
  25. fmt.Println("Failure : ", err)
  26. }
  28. // Read Response Body
  29. respBody, _ := ioutil.ReadAll(resp.Body)
  31. // Display Results
  32. fmt.Println("response Status : ", resp.Status)
  33. fmt.Println("response Headers : ", resp.Header)
  34. fmt.Println("response Body : ", string(respBody))
  35. }


Service Now RESTMessageV2

Replace in the below:

  1. //Request - RESTMessageV2
  2. try {
  3. var rm = new sn_ws.RESTMessageV2();
  4. rm.setHttpMethod("GET");
  5. rm.setEndpoint("https://YOUR_JIRA_BASEURL/rest/api/2/myself");
  6. rm.setRequestHeader('Authorization','Basic <YOUR_BASIC_AUTH_HEADER>');
  8. var response = rm.execute();
  9. var responseBody = response.getBody();
  10. var httpStatus = response.getStatusCode();
  11. gs.debug("httpStatus: {0}", httpStatus);
  12. gs.debug("responseBody: {0}", responseBody);
  13. }
  14. catch(ex) {
  15. gs.error("Request REST error", ex);
  16. }


PHP - Wordpress 

Replace in the below:

  1. <?php
  3. // {@see https://codex.wordpress.org/HTTP_API}
  4. $response = wp_remote_get( 'https://YOUR_JIRA_BASEURL/rest/api/2/myself', array(
  5. 'headers' => array(
  6. 'Authorization' => 'Basic <YOUR_BASIC_AUTH_HEADER>',
  7. ),
  8. ) );
  10. if ( ! is_wp_error( $response ) ) {
  11. // The request went through successfully, check the response code against
  12. // what we're expecting
  13. if ( 200 == wp_remote_retrieve_response_code( $response ) ) {
  14. // Do something with the response
  15. // $body = wp_remote_retrieve_body( $response );
  16. // $headers = wp_remote_retrieve_headers( $response );
  17. } else {
  18. // The response code was not what we were expecting, record the message
  19. $error_message = wp_remote_retrieve_response_message( $response );
  20. }
  21. } else {
  22. // There was an error making the request
  23. $error_message = $response->get_error_message();
  24. }



This site uses cookies to deliver its service & to analyse traffic. By browsing this site, you accept the privacy policy.

Our Wiki uses cookies

We want to give you the best possible experience on our website. For this we use technically required cookies and, if you agree, cookies for analysis and marketing purposes. You can find more information about the cookies in our Privacy Policy. By tapping ‘Accept All,’ you consent to the use of these methods by us and third parties.

Necessary
Always Active
Analytics
Advertisement
Other