Authentication
API Token
Ensure your API token has appropriate permissions for all resources you plan
to manage through Tempest.
- Email address
- API Token
- Jira Site URL (eg:
https://my_instance.atlassian.net)
How to get a Jira API Token
How to get a Jira API Token
1
Generate API Token
Generate an Atlassian API Token from your Atlassian account.
2
Access Recipes
Navigate to Recipes in Tempest and create or select a recipe.
3
Add Jira Resource
Add a new Jira resource or select an existing Jira resource in your recipe.
4
Link Credentials
Click “Add credentials” then “+Link credentials.”
5
Select Authentication Method
Select “API Token.”
6
Name Credentials
Enter a credential name for identification.
7
Enter Email
Input the email address associated with your Atlassian account.
8
Enter API Token
Input your Atlassian API token.
9
Enter Site URL
Input your Jira Cloud site URL (e.g., https://your-domain.atlassian.net).
10
Complete Connection
Click “Connect.”
Resources
Component
Create, import, and manage components within Jira projects. Components help you categorize and group issues within a project, making it easier to track and manage work across different functional areas or modules. Configuration options:- Project (required): The project this component is in
- Name (required): The name of the component
- Description: The description of the component
- Lead Account ID: The account ID of the component’s lead user
- Assignee Type: How issues are assigned when created with this component
- PROJECT_LEAD: Assign to the project lead
- COMPONENT_LEAD: Assign to the component lead
- UNASSIGNED: Leave unassigned
- PROJECT_DEFAULT: Use the project’s default assignment
- Name: The name of the component
- Description: The description of the component
- Lead: The username of the component’s lead user
- Assignee Type: The type of assignee for issues
- Project Key: The key of the project this component belongs to
- Issues URL: The URL to view issues filtered by this component in Jira
Project
Projects are import-only resources available in Jira that represent a collection of tasks that represent development work for a given product or service. Tempest can import projects into your service catalog to centralize management. Properties:- Key: The project key, which is a short identifier found in the Jira UI
- Name: The name of the Jira project
- Description: The description of the Jira project
- Project Type Key: The type of the project (e.g., ‘software’, ‘business’)
- Simplified: Whether the project is a simplified project
- Style: The style of the project (e.g., ‘classic’, ‘next-gen’)
- Privacy settings