Skip to content

Mismatch between docs and AUTH_0_ID function #16851

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
Closed
1 task done
michaelvp411 opened this issue Mar 7, 2025 · 1 comment · Fixed by #16879
Closed
1 task done

Mismatch between docs and AUTH_0_ID function #16851

michaelvp411 opened this issue Mar 7, 2025 · 1 comment · Fixed by #16879
Assignees
@EdwardAngert
Labels
docs Area: coder.com/docs

Comments

@michaelvp411
Copy link
Contributor

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

Docs: https://coder.com/docs/admin/external-auth#gitlab-self-managed
The CODER_EXTERNAL_AUTH_0_ID environment variable is used for internal reference. Set it with a value that helps you identify it. For example, you can use CODER_EXTERNAL_AUTH_0_ID="primary-github" for your GitHub provider.

The docs say it's for internal use. If you confgure this as the doc states: CODER_EXTERNAL_AUTH_0_ID="primary-gitlab"
This variable is actually used in the callback url in authentication for git lab

the default callback url in gitlab listed in the doc is:
https://your-gitlab.example.com/users/auth/gitlab/callback

When a user tries to authenctiate with gitlab Coder will connect with
https://your-gitlab.example.com/users/auth/**gitlab-primary**/callback
This will cause a error "The redirect URI included is not valid"

Image

Relevant Log Output



Expected Behavior


Docs: https://coder.com/docs/admin/external-auth#gitlab-self-managed

Clearer explanation of the function of AUTH_0_ID


Steps to Reproduce


1.https://coder.com/docs/admin/external-auth#gitlab-self-managed

2. https://docs.gitlab.com/integration/oauth_provider/

3. Attempt authentication with a SAML tracer app to see AUTH_0_ID is used as part of the callback url


Environment


    

  • Host OS:
    • 

  • Coder version:
    • 



Additional Context


No response

      		
    

      
  





        



            
            

              
            

        

      


      
    








      

    



      

  
            

    

      
    

    


      

          @michaelvp411
michaelvp411




          added
  the 

  needs-triage

  Issue that require triage
 label


      Mar 7, 2025

    

  



    


    

    

      
    

    


      

          @bpmct
bpmct




        changed the title
<title>Mismatch between docs and AUTH_0_ID function

Mismatch between docs and AUTH_0_ID function


      Mar 9, 2025

    

  








      

  
      



  

  @matifali





  


    

      

  

    

        
    
    

  


      
          
  
      
            Copy link

  

      
    

  


  

      

  
  Member


      

  


  

    

  





      


        


  
    

      
          
Thanks, @michaelvp411, for the feedback. We would be happy to review a PR that clarifies this section of the docs.

      		
    

  





        


            

            
            

              
            

        

      


      

            
  

    
  
    
    

  

  


    












      

  
            

    

      
    

    


      

          @EdwardAngert
EdwardAngert




            added
      

  docs

  Area: coder.com/docs

    and removed
      

  needs-triage

  Issue that require triage

  labels


      Mar 10, 2025

    

  



  


  
    
  
  

    
  bpmct 

      added a commit
      that referenced
      this issue

    
      Mar 11, 2025
    
    

      


  

    

      


  

      
        @bpmct
  





      

        
          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>

    




    

  




  

  

    
  


  

      

    @bpmct
bpmct



    mentioned this issue
    
      Mar 11, 2025
    





  


  

      
   Merged

  







  




  


  
    
  
  

    
  bpmct 

      added a commit
      that referenced
      this issue

    
      Mar 13, 2025
    
    

      


  

    

      


  

      
        @bpmct
  





      

        
          fix: add Agent Freedom Setting documentation and templates
        

          
            
          

      


      

          

    
    
    

  

      


      

          

    
    
    

  

  

    
  



      


      
      

        
          38ce9c5
        
      

    

  

    

      
This commit addresses the agent freedom setting mismatch issue (#16851) by:
1. Adding an Agent Freedom Setting link to the GitHub issue template configuration
2. Creating a comprehensive documentation file (agent-freedom-settings.md)
3. Adding a PR template with correct Agent Freedom Setting format

The documentation explains the various freedom levels, preset values, and how
to correctly specify agent freedom settings to avoid mismatches between preset
names and numeric values.

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>

    




    

  




  

  

    
  


  

      

    @bpmct
bpmct



    mentioned this issue
    
      Mar 13, 2025
    





  


  

      
   Closed

  







  




    

    


  


  
    
  
  

    
  EdwardAngert 

      added a commit
      that referenced
      this issue

    
      Apr 1, 2025
    
    

      


  

    

      


  

      
        @bpmct
      
        @EdwardAngert
      
        @matifali
  





      

        
          docs: clarify that CODER_EXTERNAL_AUTH_0_ID is used in callback URLs (#…
        

          
            
          

      


      

          

    
    
    

  

    


      


      

          

    
    
    

  

  

    
  



      


      
      

        
          fd24116
        
      

    

  

    

      
…16879)

## 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](https://coder.com/docs/@fix-external-auth-docs-16851/admin/external-auth)

<sub>🤖 Generated with [Claude Code](https://claude.ai/code)</sub>

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com>
Co-authored-by: M Atif Ali <atif@coder.com>

    




    

  




  


  
    
  
  

    
  EdwardAngert 

      pushed a commit
      that referenced
      this issue

    
      Apr 1, 2025
    
    

      


  

    

      


  

      
        @bpmct
      
        @EdwardAngert
  





      

        
          docs: clarify that CODER_EXTERNAL_AUTH_0_ID is used in callback URLs
        

          
            
          

      


      

          

    
    
    

  

      


      

      


      
      

        
          368b131
        
      

    

  

    

      
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>

    




    

  













  
  

    

      

  





  




  
  

              

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


  



  






  
                  




    

  


      
  

    Assignees
  



        

      

        

  
      @EdwardAngert
  
    EdwardAngert
    

      








      


  


  

    Labels
  



    

      

    docs

  Area: coder.com/docs








      

  

    

        

    Projects
  


        




    None yet




  



      


  

    
  

    Milestone
  


      No milestone





    
      
          


  

    

      
        

          
    

    Development
  




            
  
Successfully merging a pull request may close this issue.





    


  
          
      docs: clarify that CODER_EXTERNAL_AUTH_0_ID is used in callback URLs

    
      coder/coder
    





      
    

  




      

    

  
      

  

    

      3 participants
    

    

        
          @michaelvp411 
        
          @matifali 
        
          @EdwardAngert