Skip to content

Add roles to session JWT #308

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

Merged
atainter merged 1 commit into from
Sep 17, 2025
Merged

Add roles to session JWT #308

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
node_modules
dist
coverage
.idea
1 change: 1 addition & 0 deletions src/components/authkit-provider.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,7 @@ describe('useAuth', () => {
sessionId: 'test-session',
organizationId: 'test-org',
role: 'admin',
roles: ['admin'],
permissions: ['read', 'write'],
entitlements: ['feature1'],
featureFlags: ['test-flag'],
Expand Down
6 changes: 6 additions & 0 deletions src/components/authkit-provider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ type AuthContextType = {
sessionId: string | undefined;
organizationId: string | undefined;
role: string | undefined;
roles: string[] | undefined;
permissions: string[] | undefined;
entitlements: string[] | undefined;
featureFlags: string[] | undefined;
Expand Down Expand Up @@ -46,6 +47,7 @@ export const AuthKitProvider = ({ children, onSessionExpired }: AuthKitProviderP
const [sessionId, setSessionId] = useState<string | undefined>(undefined);
const [organizationId, setOrganizationId] = useState<string | undefined>(undefined);
const [role, setRole] = useState<string | undefined>(undefined);
const [roles, setRoles] = useState<string[] | undefined>(undefined);
const [permissions, setPermissions] = useState<string[] | undefined>(undefined);
const [entitlements, setEntitlements] = useState<string[] | undefined>(undefined);
const [featureFlags, setFeatureFlags] = useState<string[] | undefined>(undefined);
Expand All @@ -60,6 +62,7 @@ export const AuthKitProvider = ({ children, onSessionExpired }: AuthKitProviderP
setSessionId(auth.sessionId);
setOrganizationId(auth.organizationId);
setRole(auth.role);
setRoles(auth.roles);
setPermissions(auth.permissions);
setEntitlements(auth.entitlements);
setFeatureFlags(auth.featureFlags);
Expand All @@ -69,6 +72,7 @@ export const AuthKitProvider = ({ children, onSessionExpired }: AuthKitProviderP
setSessionId(undefined);
setOrganizationId(undefined);
setRole(undefined);
setRoles(undefined);
setPermissions(undefined);
setEntitlements(undefined);
setFeatureFlags(undefined);
Expand Down Expand Up @@ -105,6 +109,7 @@ export const AuthKitProvider = ({ children, onSessionExpired }: AuthKitProviderP
setSessionId(auth.sessionId);
setOrganizationId(auth.organizationId);
setRole(auth.role);
setRoles(auth.roles);
setPermissions(auth.permissions);
setEntitlements(auth.entitlements);
setFeatureFlags(auth.featureFlags);
Expand Down Expand Up @@ -180,6 +185,7 @@ export const AuthKitProvider = ({ children, onSessionExpired }: AuthKitProviderP
sessionId,
organizationId,
role,
roles,
permissions,
entitlements,
featureFlags,
Expand Down
2 changes: 2 additions & 0 deletions src/components/useTokenClaims.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ describe('useTokenClaims', () => {
sid: 'session_123',
org_id: 'org_123',
role: 'admin',
roles: ['admin'],
permissions: ['read', 'write'],
entitlements: ['feature_a'],
feature_flags: ['device-authorization-grant'],
Expand Down Expand Up @@ -119,6 +120,7 @@ describe('useTokenClaims', () => {
sid: 'session_123',
org_id: 'org_123',
role: 'admin',
roles: ['admin'],
permissions: ['read', 'write'],
entitlements: ['feature_a'],
feature_flags: ['device-authorization-grant'],
Expand Down
3 changes: 3 additions & 0 deletions src/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface UserInfo {
sessionId: string;
organizationId?: string;
role?: string;
roles?: string[];
permissions?: string[];
entitlements?: string[];
featureFlags?: string[];
Expand All @@ -41,6 +42,7 @@ export interface NoUserInfo {
sessionId?: undefined;
organizationId?: undefined;
role?: undefined;
roles?: undefined;
permissions?: undefined;
entitlements?: undefined;
featureFlags?: undefined;
Expand All @@ -52,6 +54,7 @@ export interface AccessToken {
sid: string;
org_id?: string;
role?: string;
roles?: string[];
permissions?: string[];
entitlements?: string[];
feature_flags?: string[];
Expand Down
5 changes: 5 additions & 0 deletions src/jwt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ export interface JWTPayload {
*/
role?: string;

/**
* Roles of the user associated with the JWT
*/
roles?: string[];

/**
* Permissions granted to the user associated with the JWT
*/
Expand Down
4 changes: 4 additions & 0 deletions src/session.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ describe('session.ts', () => {
sessionId: 'session_123',
organizationId: 'org_123',
role: 'member',
roles: ['member'],
permissions: ['posts:create', 'posts:delete'],
entitlements: ['audit-logs'],
featureFlags: ['device-authorization-grant'],
Expand Down Expand Up @@ -867,6 +868,7 @@ describe('session.ts', () => {
sub: 'user_123',
org_id: 'org_123',
role: 'admin',
roles: ['admin'],
permissions: ['read', 'write'],
entitlements: ['feature_a'],
feature_flags: ['device-authorization-grant'],
Expand All @@ -892,6 +894,7 @@ describe('session.ts', () => {
sub: 'user_123',
org_id: 'org_123',
role: 'admin',
roles: ['admin'],
permissions: ['read', 'write'],
entitlements: ['feature_a'],
feature_flags: ['device-authorization-grant'],
Expand All @@ -914,6 +917,7 @@ describe('session.ts', () => {
sid: 'session_123',
org_id: 'org_123',
role: 'admin',
roles: ['admin'],
permissions: ['read', 'write'],
entitlements: ['feature_a'],
feature_flags: ['device-authorization-grant'],
Expand Down
8 changes: 8 additions & 0 deletions src/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ async function updateSession(
sid: sessionId,
org_id: organizationId,
role,
roles,
permissions,
entitlements,
feature_flags: featureFlags,
Expand All @@ -200,6 +201,7 @@ async function updateSession(
user: session.user,
organizationId,
role,
roles,
permissions,
entitlements,
featureFlags,
Expand Down Expand Up @@ -251,6 +253,7 @@ async function updateSession(
sid: sessionId,
org_id: organizationId,
role,
roles,
permissions,
entitlements,
feature_flags: featureFlags,
Expand All @@ -264,6 +267,7 @@ async function updateSession(
user,
organizationId,
role,
roles,
permissions,
entitlements,
featureFlags,
Expand Down Expand Up @@ -347,6 +351,7 @@ async function refreshSession({
sid: sessionId,
org_id: organizationId,
role,
roles,
permissions,
entitlements,
feature_flags: featureFlags,
Expand All @@ -357,6 +362,7 @@ async function refreshSession({
user,
organizationId,
role,
roles,
permissions,
entitlements,
featureFlags,
Expand Down Expand Up @@ -428,6 +434,7 @@ async function withAuth(options?: { ensureSignedIn?: boolean }): Promise<UserInf
sid: sessionId,
org_id: organizationId,
role,
roles,
permissions,
entitlements,
feature_flags: featureFlags,
Expand All @@ -438,6 +445,7 @@ async function withAuth(options?: { ensureSignedIn?: boolean }): Promise<UserInf
user: session.user,
organizationId,
role,
roles,
permissions,
entitlements,
featureFlags,
Expand Down
1 change: 1 addition & 0 deletions src/test-helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ export async function generateTestToken(payload = {}, expired = false) {
sid: 'session_123',
org_id: 'org_123',
role: 'member',
roles: ['member'],
permissions: ['posts:create', 'posts:delete'],
entitlements: ['audit-logs'],
feature_flags: ['device-authorization-grant'],
Expand Down