Skip to content

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

Merged
Baoyuantop merged 11 commits into
apache:masterfrom
kayx23:docs-improve-oidc
Jul 3, 2025
Merged

docs: improve openid-connect plugin doc and add keycloak OIDC tutorial#11889
Baoyuantop merged 11 commits into
apache:masterfrom
kayx23:docs-improve-oidc

Conversation

@kayx23

@kayx23 kayx23 commented Jan 6, 2025

Copy link
Copy Markdown
Member

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)

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

kayx23 commented Jan 7, 2025

Copy link
Copy Markdown
Member Author

watch out for changes in #11892

Yilialinn
Yilialinn previously approved these changes Mar 14, 2025
juzhiyuan
juzhiyuan previously approved these changes Mar 16, 2025
| 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
Copy Markdown
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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Hi @bzp2010 the question here is left unanswered. Please take a look. Thanks.

@kayx23
kayx23 requested a review from bzp2010 April 17, 2025 08:59
@Baoyuantop
Baoyuantop merged commit 178bc98 into apache:master Jul 3, 2025
3 checks passed
@kayx23
kayx23 deleted the docs-improve-oidc branch July 3, 2025 03:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation things size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants