Skip to content

feat(backend): add RoleSet JSON types and missing OrganizationJSON fields#8502

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
jacekradko merged 1 commit into from
May 7, 2026
Merged

feat(backend): add RoleSet JSON types and missing OrganizationJSON fields #8502

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
5 changes: 5 additions & 0 deletions .changeset/role-set-json-types.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
"@clerk/backend": patch
---

Add `RoleSetJSON`, `RoleSetItemJSON`, and `RoleSetMigrationJSON` types matching the BAPI OpenAPI schema. Add `role_set_key`, `last_active_at`, and `missing_member_with_elevated_permissions` to `OrganizationJSON`.
50 changes: 50 additions & 0 deletions packages/backend/src/api/resources/JSON.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -66,6 +66,9 @@ export const ObjectType = {
TotalCount: 'total_count',
TestingToken: 'testing_token',
Role: 'role',
RoleSet: 'role_set',
RoleSetItem: 'role_set_item',
RoleSetMigration: 'role_set_migration',
Permission: 'permission',
BillingPayer: 'commerce_payer',
BillingPaymentAttempt: 'commerce_payment_attempt',
Expand DownExpand Up@@ -377,6 +380,53 @@ export interface OrganizationJSON extends ClerkResourceJSON {
created_by?: string;
created_at: number;
updated_at: number;
last_active_at?: number;
missing_member_with_elevated_permissions?: boolean;
role_set_key?: string | null;
}

export interface RoleSetItemJSON {
object: typeof ObjectType.RoleSetItem;
id: string;
name: string;
key: string;
description: string | null;
members_count?: number | null;
has_members?: boolean | null;
created_at: number;
updated_at: number;
}

export interface RoleSetMigrationJSON {
object: typeof ObjectType.RoleSetMigration;
id: string;
organization_id: string | null;
instance_id: string;
source_role_set_id: string;
dest_role_set_id: string | null;
trigger_type: string;
status: string;
migrated_members: number;
mappings: Record<string, string> | null;
started_at?: number;
completed_at?: number;
created_at: number;
updated_at: number;
}

export interface RoleSetJSON {
object: typeof ObjectType.RoleSet;
id: string;
name: string;
key: string;
description: string | null;
roles: RoleSetItemJSON[];
default_role: RoleSetItemJSON | null;
creator_role: RoleSetItemJSON | null;
type: 'initial' | 'custom';
role_set_migration: RoleSetMigrationJSON | null;
created_at: number;
updated_at: number;
}

export interface OrganizationDomainJSON extends ClerkResourceJSON {
Expand Down
3 changes: 3 additions & 0 deletions packages/backend/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,6 +86,9 @@ export type {
PublicOrganizationDataJSON,
OrganizationMembershipJSON,
OrganizationMembershipPublicUserDataJSON,
RoleSetJSON,
RoleSetItemJSON,
RoleSetMigrationJSON,
PhoneNumberJSON,
ProxyCheckJSON,
RedirectUrlJSON,
Expand Down
Loading