Skip to content

Commit 30051c7

Browse files
authored
docs: document jwks uri endpoint (#3537)
* docs: add overview section * docs: add link to specification
1 parent 9e4c8fb commit 30051c7

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
tags:
3+
- administration
4+
- auth-server
5+
- jwks
6+
- json-web-key-set
7+
- endpoint
8+
---
9+
10+
# Overview
11+
12+
Janssen Server supports `/jwks` metadata endpoint and publishes its JSON Web Key Set (JWKS) at this endpoint. This
13+
endpoint publishes signing keys as well as encryption keys used by Janssen Server. RP can use these keys to validate
14+
signatures from Janssen Server, and also to perform encryption and decryption. Like other metadata endpoints, this is
15+
not a secure endpoint. Further details on this endpoint and JWKs can be found in [OpenID Connect Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata)
16+
specification.
17+
18+
URL to access jwks endpoint on Janssen Server is listed in the response of Janssen Server's well-known
19+
[configuration endpoint](./configuration.md) given below.
20+
21+
```text
22+
https://janssen.server.host/jans-auth/.well-known/openid-configuration
23+
```
24+
25+
`jwks_uri` claim in the response specifies the URL for jwks endpoint. By default, the jwks endpoint looks like below:
26+
27+
```
28+
https://janssen.server.host/jans-auth/restv1/jwks
29+
```
30+
31+
This endpoint is always enabled and can not be disabled using feature flags.
32+
33+
## Configuration Properties
34+
35+
End session endpoint can be further configured using Janssen Server configuration properties listed below. When using
36+
[Janssen Text-based UI(TUI)](../../config-guide/tui.md) to configure the properties,
37+
navigate via `Auth Server`->`Properties`.
38+
39+
- [jwksUri](../../reference/json/properties/janssenauthserver-properties.md#jwksuri)
40+
- [jwksAlgorithmsSupported](../../reference/json/properties/janssenauthserver-properties.md#jwksalgorithmssupported)
41+
- [mtlsJwksUri](../../reference/json/properties/janssenauthserver-properties.md#mtlsjwksuri)
42+
43+
## Want to contribute?
44+
45+
If you have content you'd like to contribute to this page in the meantime, you can get started with our [Contribution guide](https://docs.jans.io/head/CONTRIBUTING/).

0 commit comments

Comments
 (0)