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: docs/en/latest/plugins/openid-connect.md
+6-1Lines changed: 6 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,7 +99,12 @@ The `openid-connect` Plugin supports the integration with [OpenID Connect (OIDC)
99
99
| introspection_interval | integer | False | 0 || TTL of the cached and introspected access token in seconds. The default value is 0, which means this option is not used and the Plugin defaults to use the TTL passed by expiry claim defined in `introspection_expiry_claim`. If `introspection_interval` is larger than 0 and less than the TTL passed by expiry claim defined in `introspection_expiry_claim`, use `introspection_interval`. |
100
100
| introspection_expiry_claim | string | False | exp || Name of the expiry claim, which controls the TTL of the cached and introspected access token. |
101
101
| introspection_addon_headers | array[string]| False ||| Used to append additional header values to the introspection HTTP request. If the specified header does not exist in origin request, value will not be appended. |
102
-
| claim_validator.issuer.valid_issuers | string[]| False ||| Whitelist the vetted issuers of the jwt. When not passed by the user, the issuer returned by discovery endpoint will be used. In case both are missing, the issuer will not be validated. |
| claim_validator.issuer.valid_issuers | array[string]| False ||| An array of trusted JWT issuers. If unconfigured, the issuer returned by discovery endpoint will be used. If both are unavailable, the issuer will not be validated. |
| claim_validator.audience.claim | string | False | aud || Name of the claim that contains the audience. |
106
+
| claim_validator.audience.required | boolean | False | false || If true, audience claim is required and the name of the claim will be the name defined in `claim`. |
107
+
| claim_validator.audience.match_with_client_id | boolean | False | false || If true, require the audience to match the client ID. If the audience is a string, it must exactly match the client ID. If the audience is an array of strings, at least one of the values must match the client ID. If no match is found, you will receive a `mismatched audience` error. This requirement is stated in the OpenID Connect specification to ensure that the token is intended for the specific client. |
103
108
| claim_schema | object | False ||| JSON schema of OIDC response claim. Example: `{"type":"object","properties":{"access_token":{"type":"string"}},"required":["access_token"]}` - validates that the response contains a required string field `access_token`. |
104
109
105
110
NOTE: `encrypt_fields = {"client_secret"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See [encrypted storage fields](../plugin-develop.md#encrypted-storage-fields).
0 commit comments