docs: update openid-connect attributes description and sync CN doc attributes. #7371
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
juzhiyuan
reviewed
Jul 4, 2022
| | timeout | integer | False | 3 | [1,...] | Request timeout time in seconds. | | ||
| | ssl_verify | boolean | False | false | | When set to true, verifies the identity provider's SSL certificates. | | ||
| | introspection_endpoint | string | False | | | URL of the token verification endpoint of the identity server. | | ||
| | introspection_endpoint_auth_method | string | False | | | Authentication method name for token introspection, If not specified, the default will use the first value in well_know. | |
There was a problem hiding this comment.
I'm not clear, cc @starsz to have a check 🙏
There was a problem hiding this comment.
After digging it into.I found that:
- The default value of
introspection_endpoint_auth_methodis "client_secret_basic", sorry to @hf400159 . - And the
lua-resty-openidcwill use another conf called "token_endpoint_auth_method".It doesn't introduce in the docs, but it can work well in "openid-connection" plugin.
The default value of "token_endpoint_auth_method" will fetch the first supported method specified by the OP.
refer https://github.com/zmartzone/lua-resty-openidc/blob/master/lib/resty/openidc.lua#L677
So in conclusion, I think we should keep the original doc, and add the new field of "token_endpoint_auth_method" to the docs.
There was a problem hiding this comment.
@starsz fixed. PTAL 😄
starsz
approved these changes
Jul 5, 2022
juzhiyuan
approved these changes
Jul 5, 2022
SylviaBABY
approved these changes
Jul 5, 2022
Liu-Junlin
pushed a commit
to Liu-Junlin/apisix
that referenced
this pull request
Nov 4, 2022
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.
Description
update openid-connect attributes description and add CN doc attributes.
add
token_endpoint_auth_methodattributes.Fixes # (issue)
Checklist