From 15836c5c9c4545f68b97ca218d211ab34e7affa8 Mon Sep 17 00:00:00 2001 From: Filip Skokan Date: Tue, 18 Feb 2025 11:57:52 +0100 Subject: [PATCH] docs: update getValidatedIdTokenClaims description --- docs/functions/getValidatedIdTokenClaims.md | 8 ++++---- src/index.ts | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/functions/getValidatedIdTokenClaims.md b/docs/functions/getValidatedIdTokenClaims.md index 163b88b5..7e8fc15c 100644 --- a/docs/functions/getValidatedIdTokenClaims.md +++ b/docs/functions/getValidatedIdTokenClaims.md @@ -8,15 +8,15 @@ Support from the community to continue maintaining and improving this module is ▸ **getValidatedIdTokenClaims**(`ref`): [`IDToken`](../interfaces/IDToken.md) \| `undefined` -Returns ID Token claims validated during [processRefreshTokenResponse](processRefreshTokenResponse.md), -[processBackchannelAuthenticationGrantResponse](processBackchannelAuthenticationGrantResponse.md), or [processDeviceCodeResponse](processDeviceCodeResponse.md). To -optionally validate its JWS Signature use [validateApplicationLevelSignature](validateApplicationLevelSignature.md) +Returns ID Token Claims Set from a [TokenEndpointResponse](../interfaces/TokenEndpointResponse.md) processed by e.g. +[processAuthorizationCodeResponse](processAuthorizationCodeResponse.md). To optionally validate the ID Token Signature use +[validateApplicationLevelSignature](validateApplicationLevelSignature.md). ## Parameters | Parameter | Type | Description | | ------ | ------ | ------ | -| `ref` | [`TokenEndpointResponse`](../interfaces/TokenEndpointResponse.md) | Value previously resolved from [processRefreshTokenResponse](processRefreshTokenResponse.md), [processBackchannelAuthenticationGrantResponse](processBackchannelAuthenticationGrantResponse.md), or [processDeviceCodeResponse](processDeviceCodeResponse.md). | +| `ref` | [`TokenEndpointResponse`](../interfaces/TokenEndpointResponse.md) | [TokenEndpointResponse](../interfaces/TokenEndpointResponse.md) previously resolved from e.g. [processAuthorizationCodeResponse](processAuthorizationCodeResponse.md) | ## Returns diff --git a/src/index.ts b/src/index.ts index 72c8ad00..26033bb2 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3191,12 +3191,12 @@ const idTokenClaims = new WeakMap() const jwtRefs = new WeakMap() /** - * Returns ID Token claims validated during {@link processRefreshTokenResponse}, - * {@link processBackchannelAuthenticationGrantResponse}, or {@link processDeviceCodeResponse}. To - * optionally validate its JWS Signature use {@link validateApplicationLevelSignature} + * Returns ID Token Claims Set from a {@link TokenEndpointResponse} processed by e.g. + * {@link processAuthorizationCodeResponse}. To optionally validate the ID Token Signature use + * {@link validateApplicationLevelSignature}. * - * @param ref Value previously resolved from {@link processRefreshTokenResponse}, - * {@link processBackchannelAuthenticationGrantResponse}, or {@link processDeviceCodeResponse}. + * @param ref {@link TokenEndpointResponse} previously resolved from e.g. + * {@link processAuthorizationCodeResponse} * * @returns JWT Claims Set from an ID Token, or undefined if there is no ID Token in `ref`. *