Skip to content

docs: improve openid-connect plugin doc and add keycloak OIDC tutorial #11889

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
Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

docs: improve openid-connect plugin doc and add keycloak OIDC tutorial #11889

wants to merge 11 commits into from
+1,212 −334

Conversation

kayx23
Copy link
Member

@kayx23 kayx23 commented Jan 6, 2025 •
edited
Loading

Description

Improve openid-connect plugin doc and add keycloak OIDC tutorial.

Also include the update from this PR #11892

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

Sorry, something went wrong.

@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. doc Documentation things labels Jan 6, 2025
@kayx23
Copy link
Member Author

kayx23 commented Jan 7, 2025

watch out for changes in #11892

@yardenshoham yardenshoham mentioned this pull request Jan 7, 2025
Closed
juzhiyuan
juzhiyuan previously approved these changes Mar 16, 2025
View reviewed changes
kayx23
kayx23 commented Apr 17, 2025
View reviewed changes
docs/en/latest/plugins/openid-connect.md
| client_rsa_private_key | string | False | | | Client RSA private key used to sign JWT. |
| client_rsa_private_key_id | string | False | | | Client RSA private key ID used to compute a signed JWT. |
| client_jwt_assertion_expires_in | integer | False | 60 | | Life duration of the signed JWT in seconds. |
| session_contents | object | False | | | Session content configurations. If unconfigured, all data will be stored in the session. |
Copy link
Member Author

Choose a reason for hiding this comment

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

About this session_contents update from #11892

@bzp2010 I think we should update the plugin schema as well. Could you help confirm updating the schema & associated tests are sufficient? Should these changes be done in this PR or open a new one? Thanks.

@kayx23 kayx23 requested a review from bzp2010 April 17, 2025 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@juzhiyuan juzhiyuan

@bzp2010 bzp2010

@Yilialinn Yilialinn

At least 3 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
doc Documentation things size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@kayx23 @juzhiyuan @bzp2010 @Yilialinn