feat(saml): provide a FAQ for self-hosted installation#18639
Open
aldy505 wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
|
||
| The crux of the problem here is that different IdP platforms (Okta, Azure AD, etc) use different terms and conventions for the fields necessary for the integration to work. As a result, it’s possible to map up incorrect values into Sentry, causing SSO to fail with this error message. | ||
|
|
||
| #### API throwing 500 error status when trying to login on self-hosted Sentry |
Contributor
There was a problem hiding this comment.
Bug: The new FAQ title is vague, inconsistent with other FAQs, and doesn't specify the root cause of the 500 error it addresses, potentially misleading users.
Severity: LOW
Suggested Fix
Revise the FAQ title to be a question, consistent with other FAQs in this section. The title should also be more specific about the problem it solves, such as mentioning the system.url-prefix configuration, to avoid misleading users who are experiencing 500 errors from different causes.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/organization/authentication/sso/saml2.mdx#L160
Potential issue: The new FAQ title "API throwing 500 error status when trying to login
on self-hosted Sentry" is overly vague and breaks the established question-based format
of other FAQs in the section. A 500 error during SAML login can stem from multiple
issues, such as a missing `system.url-prefix` configuration (the topic of this FAQ),
CSRF protection problems, or incorrect SAML attribute mapping. By not specifying the
cause, the title can mislead users experiencing a 500 error from a different root cause
into attempting an irrelevant fix, causing confusion and wasted time.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Closes getsentry/self-hosted#4033
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: