Skip to content

docs: clarify that CODER_EXTERNAL_AUTH_0_ID is used in callback URLs #16879

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Apr 1, 2025
Merged

docs: clarify that CODER_EXTERNAL_AUTH_0_ID is used in callback URLs #16879

merged 6 commits into from
Apr 1, 2025

Conversation

bpmct
Copy link
Member

@bpmct bpmct commented Mar 11, 2025 •
edited by EdwardAngert
Loading

Summary

  • Clarifies that the CODER_EXTERNAL_AUTH_0_ID value is used as part of the OAuth callback URL path
  • Adds explicit callback URL examples to GitLab and Bitbucket Server sections
  • Updates the GitHub OAuth app configuration instructions to be more explicit
  • Fixes the documentation mistake where it claimed this ID was only for "internal reference"

Test plan

  • Documentation change only
  • Verified consistency across all OAuth provider sections

Fixes #16851

preview

🤖 Generated with Claude Code

@bpmct @claude
docs: clarify that CODER_EXTERNAL_AUTH_0_ID is used in callback URLs
fff9d84 
This commit clarifies that the CODER_EXTERNAL_AUTH_0_ID value is used as part of the
callback URL path when configuring external authentication providers. The
documentation previously stated it was only for internal reference, which was
misleading as it's a critical part of the OAuth provider configuration.

Fixes #16851

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
@EdwardAngert EdwardAngert self-requested a review March 18, 2025 01:23
@EdwardAngert EdwardAngert added the docs Area: coder.com/docs label Mar 18, 2025
matifali
matifali approved these changes Mar 18, 2025
View reviewed changes
Copy link
Member

@matifali matifali left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks

@EdwardAngert @matifali
Update docs/admin/external-auth.md
21b35bd 
Co-authored-by: M Atif Ali <atif@coder.com>
EdwardAngert
EdwardAngert reviewed Mar 18, 2025
View reviewed changes
@EdwardAngert EdwardAngert enabled auto-merge (squash) March 18, 2025 13:57
@github-actions github-actions bot added the stale This issue is like stale bread. label Mar 26, 2025
@github-actions github-actions bot closed this Mar 30, 2025
auto-merge was automatically disabled March 30, 2025 00:07

Pull request was closed

@EdwardAngert
Copy link
Contributor

this shouldn't have staled out and I accidentally duplicated it

I'm going to (reopen this and) mix this and the duplicate branch together to grab whatever each is missing

@EdwardAngert EdwardAngert reopened this Apr 1, 2025
@EdwardAngert EdwardAngert removed the stale This issue is like stale bread. label Apr 1, 2025
@EdwardAngert EdwardAngert changed the base branch from main to 16875-git-workspace-auth April 1, 2025 20:32
@EdwardAngert EdwardAngert changed the base branch from 16875-git-workspace-auth to main April 1, 2025 20:34
@EdwardAngert
Copy link
Contributor

I didn't duplicate it - disregard that.

a little more of an update to the examples and then :shipit:

@EdwardAngert EdwardAngert merged commit fd24116 into main Apr 1, 2025
28 checks passed
@EdwardAngert EdwardAngert deleted the fix-external-auth-docs-16851 branch April 1, 2025 21:03
@github-actions github-actions bot locked and limited conversation to collaborators Apr 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@EdwardAngert EdwardAngert EdwardAngert approved these changes

@matifali matifali matifali approved these changes

@michaelvp411 michaelvp411 Awaiting requested review from michaelvp411

Assignees

@bpmct bpmct

Labels
docs Area: coder.com/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Mismatch between docs and AUTH_0_ID function
3 participants
@bpmct @EdwardAngert @matifali