Skip to content

Commit ed58f65

Browse files
committed
docs: leaner docs for OIDC Discovery
1 parent 7851fbc commit ed58f65

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,22 +37,22 @@ export default ({ env }) => ({
3737
});
3838
```
3939

40-
Or [manually](#full-options), with discovery disabled.
41-
4240
### Full options
4341

42+
Discoverable options are only required when `discovery` is `false`.
43+
4444
| Key | Required | Default | Description |
4545
|---|---|---|---|
4646
| `issuer` | yes | – | Provider issuer URL (used for discovery and id_token validation) |
47-
| `discovery` | no | `true` | Enable OIDC Discovery (`/.well-known/openid-configuration`) |
47+
| `discovery` | no | `true` | Enable OIDC Discovery |
4848
| `clientId` | yes | – | OIDC client ID |
4949
| `clientSecret` | yes | – | OIDC client secret |
5050
| `redirectUri` | yes | – | Callback URL after login |
5151
| `scopes` | no | `"openid profile email groups"` | Space-separated OIDC scopes |
52-
| `authorizationEndpoint` | only if `discovery: false` | – | Provider authorization endpoint |
53-
| `tokenEndpoint` | only if `discovery: false` | – | Provider token endpoint |
54-
| `userInfoEndpoint` | only if `discovery: false` | – | Provider userinfo endpoint |
55-
| `jwksUri` | only if `discovery: false` | – | Provider JWKS URI |
52+
| `authorizationEndpoint` | discoverable | – | Provider authorization endpoint |
53+
| `tokenEndpoint` | discoverable | – | Provider token endpoint |
54+
| `userInfoEndpoint` | discoverable | – | Provider userinfo endpoint |
55+
| `jwksUri` | discoverable | – | Provider JWKS URI |
5656
| `familyNameField` | no | `"family_name"` | Userinfo claim for last name |
5757
| `givenNameField` | no | `"given_name"` | Userinfo claim for first name |
5858
| `rememberMe` | no | `true` | Store JWT in localStorage (`true`) or cookie (`false`) |

0 commit comments

Comments
 (0)