Skip to content

docs(client): clarify private_key_jwt reserved-claim behavior #2118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nielskaspers wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(client): clarify private_key_jwt reserved-claim behavior #2118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions packages/client/src/client/authExtensions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ export function createPrivateKeyJwtAuth(options: {
alg: string;
audience?: string | URL;
lifetimeSeconds?: number;
/**
* Additional custom JWT claims to include in the signed assertion.
*
* These are merged into the JWT payload, but the standard JWT claims
* (`iss`, `sub`, `aud`, `exp`, `iat`, `jti`) are always set explicitly by the SDK and
* will override any overlapping keys provided here.
*/
claims?: Record<string, unknown>;
}): AddClientAuthentication {
return async (_headers, params, url, metadata) => {
Expand Down
Loading