Jira Cloud: Authenticate with an API Token
See more Jira Examples
Verify an API token by retrieving the authenticated user's account ID and display name. Use your Atlassian account email as the Basic authentication username and an API token as the password, not your account password.
API tokens are suitable for scripts and internal integrations. Keep tokens out of source control and logs, track their expiry, and grant only the scopes needed. A scoped token uses the Atlassian gateway URL; a token without scopes uses the site URL. Find the Cloud ID in Atlassian administration or the site's /_edge/tenant_info response. Distributable integrations should use Atlassian's supported OAuth2 app model.
The code uses an Atlassian account email and an API token without scopes with the site URL. For a scoped API token, keep Basic authentication and change baseUrl to https://api.atlassian.com/ex/jira/YOUR_CLOUD_ID. For OAuth2, use that gateway URL, omit Login/Password/BasicAuth, and set http.AuthToken to the access token. See API token authentication and OAuth2 authorization. The account must have permission for the operation; OAuth scopes do not grant additional Jira permissions.
Targets Jira Cloud. Jira Data Center has a separate REST API and may require different paths, authentication, or payloads.
Atlassian REST API documentation
Chilkat CkJava Downloads
import com.chilkatsoft.*;
public class ChilkatExample {
static {
try {
System.loadLibrary("chilkat");
} catch (UnsatisfiedLinkError e) {
System.err.println("Native code library failed to load.\n" + e);
System.exit(1);
}
}
public static void main(String argv[])
{
boolean success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
CkHttp http = new CkHttp();
http.put_RequireSslCertVerify(true);
http.put_BasicAuth(true);
// Read these credentials from private application configuration.
http.put_Login("YOUR_ATLASSIAN_EMAIL");
http.put_Password("YOUR_API_TOKEN");
String baseUrl = "https://your-domain.atlassian.net";
http.put_Accept("application/json");
CkStringBuilder url = new CkStringBuilder();
CkHttpResponse resp = new CkHttpResponse();
CkJsonObject reply = new CkJsonObject();
url.SetString(baseUrl);
url.Append("/rest/api/3/myself");
success = http.HttpNoBody("GET",url.getAsString(),resp);
if (resp.get_StatusCode() == 0) {
System.out.println("No HTTP response was received. Check connectivity and TLS settings.");
return;
}
if ((success != true) || (resp.get_StatusCode() < 200) || (resp.get_StatusCode() >= 300)) {
System.out.println("Request failed. HTTP " + resp.get_StatusCode());
if (resp.get_StatusCode() == 429) {
System.out.println("Rate limited. Retry-After: " + resp.getHeaderField("Retry-After"));
}
// Inspect this response locally; it can contain private Jira data.
System.out.println(resp.bodyStr());
return;
}
success = reply.Load(resp.bodyStr());
if (success != true) {
System.out.println("Expected a JSON object in the response.");
return;
}
if ((reply.JsonTypeOf("accountId") != 1) || (reply.StringOfEquals("accountId","",true) == true)) {
System.out.println("Missing value: accountId");
return;
}
System.out.println("Account ID: " + reply.stringOf("accountId"));
System.out.println("Display name: " + reply.stringOf("displayName"));
System.out.println("Active: " + reply.BoolOf("active"));
}
}