refactor: incorporate custom headers into default header setup #533
Conversation
This file contains 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
Modify the default headers construction to merge in custom headers if provided. This change ensures that custom headers, such as Cloudflare access tokens, are included in the request before self.get_token() is called and without overwriting the default headers like 'Authorization' and 'Content-Type'.
Fixing linting issue by adding trailing comma to key in dict
Adding `custom_headers` to KeycloakOpenID instantiation.
ryshoooo
approved these changes
Apr 7, 2024
There was a problem hiding this comment.
Thanks a lot @mattcollie
The change makes sense and overall it looks good to me :)
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.
Hi this is my first contribution to this project, and I hope I'm doing this right. If there's anything I've missed or any additional information you need, please let me know.
Overview
Refactor of
KeycloakOpenIDConnection, settingheadersandcustom_headersbefore any web request requiring any custom headers. This allows custom headers like Cloudflare access tokens to be included in the initialget_token()request.Changes
This pull request refactors how default headers are set up. I've made modifications to ensure that custom headers, when provided, are incorporated correctly before any web requests.
The key changes include:
self.get_token()method is called.'Authorization'and'Content-Type', ensuring they are not overwritten.Reason
The motivation behind these changes is to ensure custom headers are available before any web requests requiring headers are made. This was a particular error when using
KeycloakOpenIDConnectionforKeycloakAdmin.