Skip to content

docs: document OAuth2 support for jira_config's http_config - #5571

Open
xenon898 wants to merge 1 commit into
prometheus:mainfrom
xenon898:jira-oauth2-docs
Open

xenon898 wants to merge 1 commit into
prometheus:mainfrom
xenon898:jira-oauth2-docs

Conversation

@xenon898

Copy link
Copy Markdown
Contributor

The jira_config docs only described PAT-based auth (basic_auth / authorization) for http_config, even though it's the same shared <http_config> type every notifier uses and already supports OAuth2 (verified against OAuth2 in prometheus/common@v0.70.1: client_id, client_secret_file, token_url, scopes are all real fields). That's what #5475 ran into.

Adds a line noting OAuth2 is supported, and a worked example. The example uses independently-chosen placeholder values, not the one posted in the issue thread, since that suggestion was given as a plain comment rather than a signed-off contribution.

Fixes #5475

Pull Request Checklist

Which user-facing changes does this PR introduce?

[BUGFIX] docs: document OAuth2 support for jira_config's http_config

🤖 Generated with Claude Code

Signed-off-by: xenon898 <88700568+xenon898@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@xenon898
xenon898 requested a review from a team as a code owner September 17, 2026 16:43
@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 9ca0b6b7-4b13-4501-b838-af7381a60978

📥 Commits

Reviewing files that changed from the base of the PR and between 52f763c and 1c0ab12.

📒 Files selected for processing (1)
  • docs/configuration.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The Jira receiver documentation now describes OAuth2 system-to-system authentication as an alternative to personal access tokens and includes a corresponding http_config example.

Changes

Jira OAuth2 documentation

Layer / File(s) Summary
Document Jira authentication options
docs/configuration.md
The PAT instructions now mention OAuth2. A YAML example documents client_id, client_secret_file, token_url, and scopes under oauth2.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 1c0ab

The PR documents an already-supported Jira OAuth2 configuration without changing runtime behavior, so it is ready to merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: documenting OAuth2 support for Jira's http_config.
Description check ✅ Passed The description explains the change, links it to issue #5475, identifies it as documentation-only, completes the applicable checklist items, documents the user-facing change, and includes release note…
Linked Issues check ✅ Passed Issue #5475 requests an authentication method other than personal access tokens for Jira system-to-system integrations. The PR documents OAuth2 support in jira_config through the shared `http_config…
Out of Scope Changes check ✅ Passed The change is limited to the Jira http_config documentation in docs/configuration.md. The added OAuth2 explanation and configuration example directly support issue #5475. No unrelated code, behavi…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@SoloJacobs SoloJacobs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey,

I'm afraid this change is doing a bit more than it should:

  • Jira doesn't actually support like OAuth2 without clicking in the browser. This means Alertmanager cannot do this either. What we can actually do is specify an idp via http config.
  • The example defines a non-existing scope. We should probably remove that example altogether and point users to general http_config.

So, please make the change a bit more minimal. The main goal is just to check what may lead users to conclude one can't use OAuth with an idp. The OAuth solution by jira does not work for automations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Jira integration: Support for API token auth method

2 participants