Skip to content

Commit 3c9f0d9

Browse files
committed
docs: improve docs for default client authentication
Refs #761
1 parent c5df1d4 commit 3c9f0d9

File tree

3 files changed

+12
-8
lines changed

3 files changed

+12
-8
lines changed

docs/classes/Configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ let config = new client.Configuration(server, clientId, clientSecret)
5959
| ------ | ------ | ------ |
6060
| `server` | [`ServerMetadata`](../interfaces/ServerMetadata.md) | Authorization Server Metadata |
6161
| `clientId` | `string` | Client Identifier at the Authorization Server |
62-
| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed in it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
63-
| `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | Implementation of the Client's Authentication Method at the Authorization Server. |
62+
| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
63+
| `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | Implementation of the Client's Authentication Method at the Authorization Server. Default is [ClientSecretPost](../functions/ClientSecretPost.md) using the [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
6464

6565
#### Returns
6666

docs/functions/discovery.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ NOT RECOMMENDED as it disables the [ServerMetadata.issuer](../interfaces/ServerM
3131
| ------ | ------ | ------ |
3232
| `server` | [`URL`](https://developer.mozilla.org/docs/Web/API/URL) | URL representation of the Authorization Server's Issuer Identifier |
3333
| `clientId` | `string` | Client Identifier at the Authorization Server |
34-
| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed in it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret) |
35-
| `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | - |
34+
| `metadata`? | `string` \| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`ClientMetadata`](../interfaces/ClientMetadata.md)\> | Client Metadata, when a string is passed it is a shorthand for passing just [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret) |
35+
| `clientAuthentication`? | [`ClientAuth`](../type-aliases/ClientAuth.md) | Implementation of the Client's Authentication Method at the Authorization Server. Default is [ClientSecretPost](ClientSecretPost.md) using the [ClientMetadata.client\_secret](../interfaces/ClientMetadata.md#client_secret). |
3636
| `options`? | [`DiscoveryRequestOptions`](../interfaces/DiscoveryRequestOptions.md) | |
3737

3838
## Returns

src/index.ts

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1067,8 +1067,11 @@ function handleB2Clogin(server: URL, options?: DiscoveryRequestOptions) {
10671067
* @param server URL representation of the Authorization Server's Issuer
10681068
* Identifier
10691069
* @param clientId Client Identifier at the Authorization Server
1070-
* @param metadata Client Metadata, when a string is passed in it is a shorthand
1070+
* @param metadata Client Metadata, when a string is passed it is a shorthand
10711071
* for passing just {@link ClientMetadata.client_secret}
1072+
* @param clientAuthentication Implementation of the Client's Authentication
1073+
* Method at the Authorization Server. Default is {@link ClientSecretPost}
1074+
* using the {@link ClientMetadata.client_secret}.
10721075
* @param options
10731076
*
10741077
* @group OpenID Connect 1.0
@@ -1627,10 +1630,11 @@ export class Configuration
16271630
/**
16281631
* @param server Authorization Server Metadata
16291632
* @param clientId Client Identifier at the Authorization Server
1630-
* @param metadata Client Metadata, when a string is passed in it is a
1631-
* shorthand for passing just {@link ClientMetadata.client_secret}.
1633+
* @param metadata Client Metadata, when a string is passed it is a shorthand
1634+
* for passing just {@link ClientMetadata.client_secret}.
16321635
* @param clientAuthentication Implementation of the Client's Authentication
1633-
* Method at the Authorization Server.
1636+
* Method at the Authorization Server. Default is {@link ClientSecretPost}
1637+
* using the {@link ClientMetadata.client_secret}.
16341638
*/
16351639
constructor(
16361640
server: ServerMetadata,

0 commit comments

Comments
 (0)