mirror of
https://github.com/hanzoai/openid-client.git
synced 2026-09-24 17:01:10 +00:00
65 lines
2.0 KiB
Markdown
65 lines
2.0 KiB
Markdown
# Function: PrivateKeyJwt()
|
|
|
|
[💗 Help the project](https://github.com/sponsors/panva)
|
|
|
|
Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
|
|
|
|
***
|
|
|
|
â–¸ **PrivateKeyJwt**(`clientPrivateKey`, `options?`): [`ClientAuth`](../type-aliases/ClientAuth.md)
|
|
|
|
**`private_key_jwt`** uses the HTTP request body to send `client_id`,
|
|
`client_assertion_type`, and `client_assertion` as
|
|
`application/x-www-form-urlencoded` body parameters. Digital signature is
|
|
used for the assertion's authenticity and integrity.
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| ------ | ------ | ------ |
|
|
| `clientPrivateKey` | [`CryptoKey`](https://developer.mozilla.org/docs/Web/API/CryptoKey) \| [`PrivateKey`](../interfaces/PrivateKey.md) | - |
|
|
| `options?` | [`ModifyAssertionOptions`](../interfaces/ModifyAssertionOptions.md) | - |
|
|
|
|
## Returns
|
|
|
|
[`ClientAuth`](../type-aliases/ClientAuth.md)
|
|
|
|
## Examples
|
|
|
|
Usage with a [Configuration](../classes/Configuration.md) obtained through [discovery](discovery.md)
|
|
|
|
```ts
|
|
let server!: URL
|
|
let key!: client.CryptoKey | client.PrivateKey
|
|
let clientId!: string
|
|
let clientMetadata!: Partial<client.ClientMetadata> | string | undefined
|
|
|
|
let config = await client.discovery(
|
|
server,
|
|
clientId,
|
|
clientMetadata,
|
|
client.PrivateKeyJwt(key),
|
|
)
|
|
```
|
|
|
|
Usage with a [Configuration](../classes/Configuration.md) instance
|
|
|
|
```ts
|
|
let server!: client.ServerMetadata
|
|
let key!: client.CryptoKey | client.PrivateKey
|
|
let clientId!: string
|
|
let clientMetadata!: Partial<client.ClientMetadata> | string | undefined
|
|
|
|
let config = new client.Configuration(
|
|
server,
|
|
clientId,
|
|
clientMetadata,
|
|
client.PrivateKeyJwt(key),
|
|
)
|
|
```
|
|
|
|
## See
|
|
|
|
- [OAuth Token Endpoint Authentication Methods](https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml#token-endpoint-auth-method)
|
|
- [OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0-errata2.html#ClientAuthentication)
|