Minor updates to OIDC docs #6551
Merged
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
ncabatoff
reviewed
Apr 8, 2019
| @@ -102,8 +102,8 @@ entities attempting to login. At least one of the bound values must be set. | |||
| ### Parameters | |||
| - `name` `(string: <required>)` - Name of the role. | |||
| - `role_type` `(string: <optional>)` - Type of role, either "oidc" (default) or "jwt". | |||
| - `bound_audiences` `(array: <required>)` - List of `aud` claims to match | |||
There was a problem hiding this comment.
Suggest instead:
bound_audiences (array: <optional>) - Required for "jwt" roles, optional for "oidc" roles. List of aud claims to match against. Any match is sufficient.
That way jwt people skimming / reading too quickly are less likely to overlook it.
But your way is fine too.
There was a problem hiding this comment.
I authored it that way at first, but decided the current way is OK since: a) we expect more OIDC use now that it's available b) if they omit it during the JWT role creation, they'll get an error saying it's required.
ncabatoff
approved these changes
Apr 8, 2019
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.
No description provided.