You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: keps/sig-auth/3331-structured-config-for-oidc-authentication/README.md
+12-12Lines changed: 12 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -339,7 +339,7 @@ type JWTAuthenticator struct {
339
339
// Required to be unique.
340
340
URLstring`json:"url,omitempty"`
341
341
342
-
//If specified, overrides the URL used to fetch discovery information.
342
+
//discoveryURL if specified, overrides the URL used to fetch discovery information.
343
343
// Format must be https://url/path.
344
344
// Example:
345
345
// curl oidc.oidc-namespace (.discoveryURL field)
@@ -369,24 +369,24 @@ type JWTAuthenticator struct {
369
369
370
370
```go
371
371
typeClaimValidationRulestruct {
372
-
//Claim is the name of a required claim.
372
+
//claim is the name of a required claim.
373
373
// Same as --oidc-required-claim flag.
374
374
// Only string claims are supported.
375
375
// Mutually exclusive with expression and message.
376
376
// +optional
377
377
Claimstring`json:"claim"`
378
-
//RequiredValue is the value of a required claim.
378
+
//requiredValue is the value of a required claim.
379
379
// Same as --oidc-required-claim flag.
380
380
// Mutually exclusive with expression and message.
381
381
// +optional
382
382
RequiredValuestring`json:"requiredValue"`
383
383
384
-
//Expression is a logical expression that is written in CEL https://github.com/google/cel-go.
384
+
//expression is a logical expression that is written in CEL https://github.com/google/cel-go.
385
385
// Must return true for the validation to pass.
386
386
// Mutually exclusive with claim and requiredValue.
387
387
// +optional
388
388
Expressionstring`json:"expression"`
389
-
//Message customizes the returned error message when expression returns false.
389
+
//message customizes the returned error message when expression returns false.
390
390
// Mutually exclusive with claim and requiredValue.
391
391
// Note that messageExpression is explicitly not supported to avoid
392
392
// misconfigured expressions from leaking JWT payload contents.
@@ -417,7 +417,7 @@ type JWTAuthenticator struct {
417
417
418
418
```go
419
419
type ClaimMappings struct {
420
-
// Username represents an option for the username attribute.
420
+
// username represents an option for the username attribute.
421
421
// Claim must be a singular string claim.
422
422
// TODO: decide whether to support a distributed claim for username (what are we required to correlate between the data retrieved for distributed claims? sub? something else?). Limit distributed claim support to OIDC things with clientID validation?
423
423
// Expression must produce a string value.
@@ -427,20 +427,20 @@ type JWTAuthenticator struct {
427
427
// (3) if userName.expression is set instead, result of expression is used as-is without any implicit prefix
428
428
// (1) and (2) ensure backward compatibility with the --oidc-username-claim and --oidc-username-prefix flags
0 commit comments