hanzoai/openid-client
2
0
Fork 0
mirror of https://github.com/hanzoai/openid-client.git synced 2026-09-24 17:01:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: explain more discovery() behaviours

Browse Source
This commit is contained in:
Filip Skokan
2024-12-06 18:10:27 +01:00
parent 5ea88494d0
commit ce28ea5d01
2 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/functions/discovery.md
+8 -1
View File
@@ -12,12 +12,19 @@ Performs Authorization Server Metadata discovery and returns a
[Configuration](../classes/Configuration.md) with the discovered
[Authorization Server](../interfaces/ServerMetadata.md) metadata.
This is the RECOMMENDED method of client configuration.
Passing the Authorization Server's Issuer Identifier to this method is the
RECOMMENDED method of client configuration.
This has the same effect as calling the [Configuration](../classes/Configuration.md) constructor
except that the server metadata is discovered from its own Authorization
Server Metadata discovery document.
Note: This method also accepts a URL pointing directly to the Authorization
Server's discovery document, doing so is merely a shorthand for using
[fetch](https://developer.mozilla.org/docs/Web/API/Window/fetch) and passing the discovered JSON metadata (as
[ServerMetadata](../interfaces/ServerMetadata.md)) into the [Configuration](../classes/Configuration.md) constructor. Doing so is
NOT RECOMMENDED as it disables the [ServerMetadata.issuer](../interfaces/ServerMetadata.md#issuer) validation.
## Parameters
| Parameter | Type | Description |
src/index.ts
+8 -1
View File
@@ -1050,12 +1050,19 @@ function handleB2Clogin(server: URL, options?: DiscoveryRequestOptions) {
* {@link Configuration} with the discovered
* {@link ServerMetadata Authorization Server} metadata.
*
* This is the RECOMMENDED method of client configuration.
* Passing the Authorization Server's Issuer Identifier to this method is the
* RECOMMENDED method of client configuration.
*
* This has the same effect as calling the {@link Configuration} constructor
* except that the server metadata is discovered from its own Authorization
* Server Metadata discovery document.
*
* Note: This method also accepts a URL pointing directly to the Authorization
* Server's discovery document, doing so is merely a shorthand for using
* {@link !fetch} and passing the discovered JSON metadata (as
* {@link ServerMetadata}) into the {@link Configuration} constructor. Doing so is
* NOT RECOMMENDED as it disables the {@link ServerMetadata.issuer} validation.
*
* @param server URL representation of the Authorization Server's Issuer
* Identifier
* @param clientId Client Identifier at the Authorization Server