Skip to content

Commit ace7572

Browse files
docs: Add comprehensive OAuth authorization setup guide to Jira integration
- Added 'Setup & Authorization' section with detailed OAuth flow explanation - Documented site admin authorization requirement and resolution steps - Listed all Jira permissions requested by Codegen (jira-webhook, jira-user, jira-work) - Explained privacy and data access implications - Provided clear guidance for resolving common authorization issues This addresses the common user experience where Atlassian displays a message requiring site admin authorization before Codegen can access the account. Co-authored-by: Jay Hack <[email protected]>
1 parent 96f4c65 commit ace7572

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

docs/integrations/jira.mdx

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,54 @@ Follow these steps to successfully connect Codegen to your Jira workspace:
4040
Make sure you are logged in as the Codegen Jira user when authorizing access. This is to ensure Codegen acts on behalf of the new user and not your personal account.
4141
</Warning>
4242

43+
## Setup & Authorization
44+
45+
When connecting Codegen to your Jira workspace, you may encounter an authorization screen from Atlassian that requires additional setup. Here's what to expect and how to resolve common authorization issues:
46+
47+
### OAuth Authorization Process
48+
49+
During the OAuth flow, Atlassian will display an authorization screen showing:
50+
51+
1. **App Information**: Details about Codegen requesting access to your Jira account
52+
2. **Permissions Requested**: A list of specific permissions Codegen needs (see below)
53+
3. **Authorization Options**: Buttons to approve or deny access
54+
55+
### Site Admin Authorization Requirement
56+
57+
**Common Issue**: You may see a message stating that a site administrator needs to authorize Codegen before you can proceed.
58+
59+
**Resolution Steps**:
60+
1. **Contact Your Jira Administrator**: Reach out to your Jira site administrator and ask them to:
61+
- Log in to your Jira instance as an administrator
62+
- Navigate to the same OAuth authorization URL
63+
- Review and approve Codegen's access request
64+
65+
2. **Administrator Approval Process**: Your admin will see the same authorization screen and can approve Codegen for your entire organization
66+
67+
3. **Retry Authorization**: Once your administrator has approved Codegen, return to the authorization flow and complete the process
68+
69+
### Permissions Requested by Codegen
70+
71+
Codegen requests the following permissions from your Jira workspace:
72+
73+
- **`jira-webhook`**: Allows Codegen to receive notifications about issue updates, comments, and status changes
74+
- **`jira-user`**: Enables Codegen to read user information and perform actions on behalf of the authorized user
75+
- **`jira-work`**: Grants access to read and write issue data, including creating, updating, and commenting on issues
76+
77+
### Privacy & Data Access
78+
79+
**What Codegen Can Access**:
80+
- Issue details, comments, and status information
81+
- Project information and team member lists
82+
- User profile information for the authorized account
83+
84+
**What Codegen Cannot Access**:
85+
- Personal information beyond what's necessary for Jira integration
86+
- Data from other Atlassian products unless explicitly authorized
87+
- Administrative settings or sensitive configuration data
88+
89+
**Data Usage**: Codegen only uses this data to perform the specific actions you request, such as updating issue status, adding comments, or linking GitHub PRs to Jira issues.
90+
4391
### 4. Switch Back to Your Own Jira Account
4492
- After connecting, log out of the Codegen Jira user in Jira.
4593
- Log back in with your personal Jira account.
@@ -63,4 +111,3 @@ Agents use the Jira integration to streamline project management:
63111
- **Link Code:** Connect implemented changes (GitHub PRs) directly to the relevant Jira issue.
64112
- **Provide Updates:** Post comments on issues with progress reports, results, or questions.
65113
- **Create Tasks:** Generate new issues for follow-up work, bugs discovered, or sub-tasks.
66-

0 commit comments

Comments
 (0)