Skip to content

Commit e9e3c9b

Browse files
authored
fix: clarify default jwks (#1709)
1 parent 55d635b commit e9e3c9b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/oauth2-oidc/jwt-access-token.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,21 @@ http://{project.slug}.projects.oryapis.com/.well-known/jwks.json
119119

120120
All necessary keys are available there.
121121

122+
#### Default JSON Web Key Sets
123+
124+
In Ory, JSON Web Key (JWK) endpoints require a `set-id`. This `set-id` corresponds to the specific set of keys you want to
125+
interact with. If you're looking to interact with the default keys used by Ory, you can use the following `set-id` values:
126+
127+
- `hydra.openid.id-token`: This set contains the keys used for signing OpenID Connect ID Tokens.
128+
- `hydra.jwt.access-token`: This set contains the keys used for signing JWT Access Tokens.
129+
130+
You can use these `set-id` values with the JWK endpoints to retrieve, rotate, or otherwise manage these default key sets. For
131+
example, to retrieve the OpenID Connect ID Token key set, you would use the GET /admin/keys/{set} endpoint with
132+
`hydra.openid.id-token` as the `{set}` parameter. This information is particularly useful when rotating keys, as described in the
133+
[documentation on key rotation](https://www.ory.sh/docs/hydra/self-hosted/secrets-key-rotation). Remember, these are the default
134+
key sets used by Ory. If you've configured Ory to use different key sets, you'll need to use the `set-id` values corresponding to
135+
your custom key sets.
136+
122137
## Custom consent UI and custom claims for (JWT) access token
123138

124139
Using the following code during, you can add custom claims to every access token during consent acceptance

0 commit comments

Comments
 (0)