Skip to content

Update WorkOS debugging section with example JWT configuration #234

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update WorkOS debugging section with example JWT configuration #234

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
15 changes: 13 additions & 2 deletions npm-packages/docs/docs/auth/authkit/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,8 +777,19 @@ Common issues with WorkOS AuthKit integration:
matches what's configured in your WorkOS Dashboard
4. **Missing `aud` claim**: WorkOS JWTs may not include the `aud` (audience)
claim by default, which Convex requires for token validation. Check your
WorkOS Dashboard JWT configuration to ensure the audience claim is properly
set to your Client ID
WorkOS Dashboard under `Authentication > Sessions > JWT Template` to ensure the audience claim is properly
set to your Client ID. If you have not added any custom JWT properties, this will look like the following (make sure to replace the `aud` key's value with your client id).

```
{
"aud": "client_xxxxxxxxxxxxxxx",
"urn:myapp:full_name": "{{ user.first_name || 'Someone' }} {{ user.last_name || 'Unknown' }}",
"urn:myapp:email": "{{ user.email }}",
"urn:myapp:organization_tier": "{{ organization.metadata.tier || 'bronze' }}",
"urn:myapp:user_language": "{{ user.metadata.language || 'en' }}",
"urn:myapp:organization_domain": "{{ organization.domains.0.domain }}"
}
```

For more thorough debugging steps, see the WorkOS AuthKit documentation or
[Debugging Authentication](/auth/debug.mdx).
Expand Down