Skip to content

Commit f667146

Browse files
committed
docs(managesieve): document usage of oidc authentication
1 parent 77d22fd commit f667146

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/modules/servers/partials/configure/sieve.adoc

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,28 @@ Optional integer, defaults to 2 times the count of CPUs.
8686
| maxExecutorCount
8787
| Set the maximum count of worker threads. Worker threads takes care of potentially blocking tasks like executing ManageSieve commands.
8888
Optional integer, defaults to 16.
89-
|===
89+
90+
| oidc
91+
| If this property is present, OIDC will be configured and the following properties are mandatory (unless otherwise specified).
92+
93+
| oidc.oidcConfigurationURL
94+
| Your identity provider's OIDC discovery URL. This is currently not used for managesieve but is still required when OIDC is configured.
95+
96+
| oidc.jwksURL
97+
| URL to the endpoint for the JSON Web Key Set of your provider. This is used to locally validate tokens.
98+
99+
| oidc.claim
100+
| Name of the claim in the token you want to use as the identifier for the user (e.g. "email_address").
101+
102+
| oidc.scope
103+
| OIDC scope. This is currently not used for managesieve but is still required when OIDC is configured.
104+
105+
| oidc.introspection.url
106+
| URL to your identity provider's introspection endpoint. It is optional and if specified James will use the endpoint to validate the token in addition to local validation.
107+
108+
| oidc.introspection.auth
109+
| Provide Authorization header for introspection requests (optional, e.g. `Basic xyz`).
110+
111+
| oidc.userinfo.url
112+
| URL to your identity provider's userinfo endpoint. It is optional and if specified James will use the endpoint to validate the token in addition to local validation. James will ignore this option if `oidc.introspection.url` is already configured.
113+
|===

0 commit comments

Comments
 (0)