Skip to main content

​
Authentication Method

​
API Token Setup

​
Step 1: Create an API Token

  1. Log in to id.atlassian.com/manage-profile/security/api-tokens
  2. Click Create API token
  3. Give it a label (e.g., “Corsair Integration”)
  4. Click Create
  5. Copy the token immediately — you won’t be able to see it again
  6. Store it securely
The Jira plugin uses your email + API token for authentication (Basic Auth). Store the token as the api_key: Storing Credentials: 
pnpm corsair setup --plugin=jira api_key=your-api-token
Your Jira cloud URL (e.g., https://yourcompany.atlassian.net) and email address may also be required in your plugin configuration depending on your setup.

​
Webhook Setup (Optional)

  1. In Jira, go to Settings → System → WebHooks
  2. Click Create a WebHook
  3. Enter your endpoint URL and select the events you want
  4. Copy the secret if provided
pnpm corsair setup --plugin=jira webhook_signature=your-webhook-secret

​
Required Credentials Summary

CredentialRequired ForWhere to Find
API TokenAll API callsAtlassian Account → Security → API Tokens
Webhook SecretWebhook verificationJira Settings → System → WebHooks
For general information about how Corsair handles authentication, see Authentication.