Skip to content

Commit

Permalink
docs: document jwks uri endpoint (#3537)
Browse files Browse the repository at this point in the history
* docs: add overview section

* docs: add link to specification
  • Loading branch information
ossdhaval authored Jan 9, 2023
1 parent 9e4c8fb commit 30051c7
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions docs/admin/auth-server/endpoints/jwks-uri.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
tags:
- administration
- auth-server
- jwks
- json-web-key-set
- endpoint
---

# Overview

Janssen Server supports `/jwks` metadata endpoint and publishes its JSON Web Key Set (JWKS) at this endpoint. This
endpoint publishes signing keys as well as encryption keys used by Janssen Server. RP can use these keys to validate
signatures from Janssen Server, and also to perform encryption and decryption. Like other metadata endpoints, this is
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)
specification.

URL to access jwks endpoint on Janssen Server is listed in the response of Janssen Server's well-known
[configuration endpoint](./configuration.md) given below.

```text
https://janssen.server.host/jans-auth/.well-known/openid-configuration
```

`jwks_uri` claim in the response specifies the URL for jwks endpoint. By default, the jwks endpoint looks like below:

```
https://janssen.server.host/jans-auth/restv1/jwks
```

This endpoint is always enabled and can not be disabled using feature flags.

## Configuration Properties

End session endpoint can be further configured using Janssen Server configuration properties listed below. When using
[Janssen Text-based UI(TUI)](../../config-guide/tui.md) to configure the properties,
navigate via `Auth Server`->`Properties`.

- [jwksUri](../../reference/json/properties/janssenauthserver-properties.md#jwksuri)
- [jwksAlgorithmsSupported](../../reference/json/properties/janssenauthserver-properties.md#jwksalgorithmssupported)
- [mtlsJwksUri](../../reference/json/properties/janssenauthserver-properties.md#mtlsjwksuri)

## Want to contribute?

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 comments on commit 30051c7

Please sign in to comment.