Skip to content

nit(opsgenie): add config access requirement to error text #74111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

mifu67
Copy link
Contributor

@mifu67 mifu67 commented Jul 10, 2024

Users who set up their Opsgenie API keys via the Opsgenie API were experiencing problems due to a lack of configuration access. However, the error message that they encountered did not indicate that this was the problem, so this PR makes the issue more clear.

@mifu67 mifu67 requested a review from a team July 10, 2024 22:45
@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Jul 10, 2024
@cathteng
Copy link
Member

what is configuration access? do you have a link

@mifu67
Copy link
Contributor Author

mifu67 commented Jul 10, 2024

{
  "type": "Sentry",
  "name": "SentryIntegrationAPI",
  "ownerTeam": {
    	"name": "[TEAM NAME]"
    },
  "allowReadAccess" : true,
	"allowWriteAccess" : true,
	"allowDeleteAccess" : false,
	"allowConfigurationAccess" : true,
  "ignoreRespondersFromPayload": false,
  "ignoreTeamsFromPayload": false,
  "suppressNotifications": false
}

Configuration access is necessary to hit the key authentication endpoint (https://api.opsgenie.com/v2/integrations/authenticate). If allowConfigurationAccess is set to false, then the following response results:

{
    "code": 40301,
    "message": "API Key is not granted with configuration access.",
    "took": 0.001,
    "requestId": "ee466ef4-c807-438e-b70c-b642f52e90b4"
}

@mifu67
Copy link
Contributor Author

mifu67 commented Jul 10, 2024

This is specifically for key creation via the API; keys created in the Opsgenie UI seem to have configuration access enabled automatically

@mifu67 mifu67 requested review from a team and removed request for a team July 10, 2024 23:03
@cathteng
Copy link
Member

do we need to point them to documentation?

@mifu67
Copy link
Contributor Author

mifu67 commented Jul 11, 2024

The Opsgenie docs don't say anything about needing config access to authenticate. It could be helpful to point to the Sentry docs. What do you think?

@mifu67 mifu67 marked this pull request as ready for review July 15, 2024 16:13
@mifu67 mifu67 requested a review from a team as a code owner July 15, 2024 16:13
@mifu67 mifu67 merged commit 3764770 into master Jul 15, 2024
50 checks passed
@mifu67 mifu67 deleted the mifu67/opsgenie-help-text branch July 15, 2024 16:14
@github-actions github-actions bot locked and limited conversation to collaborators Jul 31, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Scope: Backend Automatically applied to PRs that change backend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants