Skip to content

feat(backend): Add Backend API calls for organization perms, roles#8774

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
wobsoriano merged 1 commit into from
Jun 8, 2026
Merged

feat(backend): Add Backend API calls for organization perms, roles #8774

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
9 changes: 9 additions & 0 deletions .changeset/orgs-rbac-backend-endpoints.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.
127 changes: 127 additions & 0 deletions packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'deadbeef',
});

const permissionId = 'perm_123';

const mockPermission = {
object: 'permission',
id: permissionId,
name: 'Manage Billing',
key: 'org:billing:manage',
description: 'Allows managing billing',
created_at: 1640995200,
updated_at: 1640995200,
};

const mockPaginatedResponse = {
data: [mockPermission],
total_count: 1,
};

it('lists organization permissions with query parameters', async () => {
server.use(
http.get(
'https://api.clerk.test/v1/organization_permissions',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('10');
expect(url.searchParams.get('offset')).toBe('5');
expect(url.searchParams.get('query')).toBe('billing');
expect(url.searchParams.get('order_by')).toBe('-created_at');
return HttpResponse.json(mockPaginatedResponse);
}),
),
);

const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
limit: 10,
offset: 5,
query: 'billing',
orderBy: '-created_at',
});

expect(response.data).toHaveLength(1);
expect(response.totalCount).toBe(1);
expect(response.data[0].key).toBe('org:billing:manage');
});

it('fetches an organization permission by ID', async () => {
server.use(
http.get(
`https://api.clerk.test/v1/organization_permissions/${permissionId}`,
validateHeaders(() => HttpResponse.json(mockPermission)),
),
);

const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

expect(response.id).toBe(permissionId);
expect(response.name).toBe('Manage Billing');
});

it('creates an organization permission', async () => {
const createParams = {
name: 'Manage Billing',
key: 'org:billing:manage',
description: 'Allows managing billing',
};

server.use(
http.post(
'https://api.clerk.test/v1/organization_permissions',
validateHeaders(async ({ request }) => {
const body = await request.json();
expect(body).toEqual(createParams);
return HttpResponse.json(mockPermission);
}),
),
);

const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

expect(response.id).toBe(permissionId);
});

it('updates an organization permission', async () => {
server.use(
http.patch(
`https://api.clerk.test/v1/organization_permissions/${permissionId}`,
validateHeaders(async ({ request }) => {
const body = await request.json();
expect(body).toEqual({ name: 'Updated' });
return HttpResponse.json({ ...mockPermission, name: 'Updated' });
}),
),
);

const response = await apiClient.organizationPermissions.updateOrganizationPermission({
permissionId,
name: 'Updated',
});

expect(response.name).toBe('Updated');
});

it('deletes an organization permission', async () => {
server.use(
http.delete(
`https://api.clerk.test/v1/organization_permissions/${permissionId}`,
validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
),
);

const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

expect(response.id).toBe(permissionId);
expect(response.deleted).toBe(true);
});
});
166 changes: 166 additions & 0 deletions packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
const apiClient = createBackendApiClient({
apiUrl: 'https://api.clerk.test',
secretKey: 'deadbeef',
});

const roleId = 'role_123';
const permissionId = 'perm_123';

const mockPermission = {
object: 'permission',
id: permissionId,
name: 'Manage Billing',
key: 'org:billing:manage',
description: 'Allows managing billing',
created_at: 1640995200,
updated_at: 1640995200,
};

const mockRole = {
object: 'role',
id: roleId,
name: 'Billing Manager',
key: 'org:billing_manager',
description: null,
is_creator_eligible: false,
permissions: [mockPermission],
created_at: 1640995200,
updated_at: 1640995200,
};

const mockPaginatedResponse = {
data: [mockRole],
total_count: 1,
};

it('lists organization roles with query parameters', async () => {
server.use(
http.get(
'https://api.clerk.test/v1/organization_roles',
validateHeaders(({ request }) => {
const url = new URL(request.url);
expect(url.searchParams.get('limit')).toBe('20');
expect(url.searchParams.get('query')).toBe('billing');
return HttpResponse.json(mockPaginatedResponse);
}),
),
);

const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

expect(response.data).toHaveLength(1);
expect(response.totalCount).toBe(1);
expect(response.data[0].permissions).toHaveLength(1);
expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
});

it('fetches an organization role by ID', async () => {
server.use(
http.get(
`https://api.clerk.test/v1/organization_roles/${roleId}`,
validateHeaders(() => HttpResponse.json(mockRole)),
),
);

const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

expect(response.id).toBe(roleId);
expect(response.description).toBeNull();
});

it('creates an organization role', async () => {
const createParams = {
name: 'Billing Manager',
key: 'org:billing_manager',
permissions: [permissionId],
};

server.use(
http.post(
'https://api.clerk.test/v1/organization_roles',
validateHeaders(async ({ request }) => {
const body = await request.json();
expect(body).toEqual(createParams);
return HttpResponse.json(mockRole);
}),
),
);

const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

expect(response.id).toBe(roleId);
});

it('updates an organization role', async () => {
server.use(
http.patch(
`https://api.clerk.test/v1/organization_roles/${roleId}`,
validateHeaders(async ({ request }) => {
const body = await request.json();
expect(body).toEqual({ name: 'Updated' });
return HttpResponse.json({ ...mockRole, name: 'Updated' });
}),
),
);

const response = await apiClient.organizationRoles.updateOrganizationRole({
organizationRoleId: roleId,
name: 'Updated',
});

expect(response.name).toBe('Updated');
});

it('deletes an organization role', async () => {
server.use(
http.delete(
`https://api.clerk.test/v1/organization_roles/${roleId}`,
validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
),
);

const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

expect(response.id).toBe(roleId);
expect(response.deleted).toBe(true);
});

it('assigns a permission to an organization role', async () => {
server.use(
http.post(
`https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
validateHeaders(() => HttpResponse.json(mockRole)),
),
);

const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
organizationRoleId: roleId,
permissionId,
});

expect(response.id).toBe(roleId);
});

it('removes a permission from an organization role', async () => {
server.use(
http.delete(
`https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
validateHeaders(() => HttpResponse.json(mockRole)),
),
);

const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
organizationRoleId: roleId,
permissionId,
});

expect(response.id).toBe(roleId);
});
});
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(backend): Add Backend API calls for organization perms, roles by dmoerner · Pull Request #8774 · clerk/javascript · GitHub
Skip to content
feat(backend): Add Backend API calls for organization perms, roles#8774

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

wobsoriano
merged 1 commit into

from

Jun 8, 2026
 Merged


feat(backend): Add Backend API calls for organization perms, roles
#8774
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


9 changes: 9 additions & 0 deletions
.changeset/orgs-rbac-backend-endpoints.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
---
"@clerk/backend": minor
---

Add Backend API support for managing instance-level organization RBAC. `createClerkClient()` now exposes:

- `organizationPermissions` — list, get, create, update, and delete organization permissions.
- `organizationRoles` — list, get, create, update, and delete organization roles, plus assign/remove a permission to/from a role.
- `roleSets` — list, get, create, update, add roles to, replace a role in, and replace a role set.

127 changes: 127 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationPermissionApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationPermissionAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockPermission],
 total_count: 1,
 };

 it('lists organization permissions with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('10');
 expect(url.searchParams.get('offset')).toBe('5');
 expect(url.searchParams.get('query')).toBe('billing');
 expect(url.searchParams.get('order_by')).toBe('-created_at');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermissionList({
 limit: 10,
 offset: 5,
 query: 'billing',
 orderBy: '-created_at',
 });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization permission by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockPermission)),
 ),
 );

 const response = await apiClient.organizationPermissions.getOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.name).toBe('Manage Billing');
 });

 it('creates an organization permission', async () => {
 const createParams = {
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_permissions',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockPermission);
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.createOrganizationPermission(createParams);

 expect(response.id).toBe(permissionId);
 });

 it('updates an organization permission', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockPermission, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationPermissions.updateOrganizationPermission({
 permissionId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization permission', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json({ object: 'permission', id: permissionId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationPermissions.deleteOrganizationPermission(permissionId);

 expect(response.id).toBe(permissionId);
 expect(response.deleted).toBe(true);
 });
});

166 changes: 166 additions & 0 deletions
packages/backend/src/api/__tests__/OrganizationRoleApi.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
import { http, HttpResponse } from 'msw';
import { describe, expect, it } from 'vitest';

import { server, validateHeaders } from '../../mock-server';
import { createBackendApiClient } from '../factory';

describe('OrganizationRoleAPI', () => {
 const apiClient = createBackendApiClient({
 apiUrl: 'https://api.clerk.test',
 secretKey: 'deadbeef',
 });

 const roleId = 'role_123';
 const permissionId = 'perm_123';

 const mockPermission = {
 object: 'permission',
 id: permissionId,
 name: 'Manage Billing',
 key: 'org:billing:manage',
 description: 'Allows managing billing',
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockRole = {
 object: 'role',
 id: roleId,
 name: 'Billing Manager',
 key: 'org:billing_manager',
 description: null,
 is_creator_eligible: false,
 permissions: [mockPermission],
 created_at: 1640995200,
 updated_at: 1640995200,
 };

 const mockPaginatedResponse = {
 data: [mockRole],
 total_count: 1,
 };

 it('lists organization roles with query parameters', async () => {
 server.use(
 http.get(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(({ request }) => {
 const url = new URL(request.url);
 expect(url.searchParams.get('limit')).toBe('20');
 expect(url.searchParams.get('query')).toBe('billing');
 return HttpResponse.json(mockPaginatedResponse);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRoleList({ limit: 20, query: 'billing' });

 expect(response.data).toHaveLength(1);
 expect(response.totalCount).toBe(1);
 expect(response.data[0].permissions).toHaveLength(1);
 expect(response.data[0].permissions[0].key).toBe('org:billing:manage');
 });

 it('fetches an organization role by ID', async () => {
 server.use(
 http.get(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.getOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.description).toBeNull();
 });

 it('creates an organization role', async () => {
 const createParams = {
 name: 'Billing Manager',
 key: 'org:billing_manager',
 permissions: [permissionId],
 };

 server.use(
 http.post(
 'https://api.clerk.test/v1/organization_roles',
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual(createParams);
 return HttpResponse.json(mockRole);
 }),
 ),
 );

 const response = await apiClient.organizationRoles.createOrganizationRole(createParams);

 expect(response.id).toBe(roleId);
 });

 it('updates an organization role', async () => {
 server.use(
 http.patch(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(async ({ request }) => {
 const body = await request.json();
 expect(body).toEqual({ name: 'Updated' });
 return HttpResponse.json({ ...mockRole, name: 'Updated' });
 }),
 ),
 );

 const response = await apiClient.organizationRoles.updateOrganizationRole({
 organizationRoleId: roleId,
 name: 'Updated',
 });

 expect(response.name).toBe('Updated');
 });

 it('deletes an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}`,
 validateHeaders(() => HttpResponse.json({ object: 'role', id: roleId, deleted: true })),
 ),
 );

 const response = await apiClient.organizationRoles.deleteOrganizationRole(roleId);

 expect(response.id).toBe(roleId);
 expect(response.deleted).toBe(true);
 });

 it('assigns a permission to an organization role', async () => {
 server.use(
 http.post(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.assignPermissionToOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });

 it('removes a permission from an organization role', async () => {
 server.use(
 http.delete(
 `https://api.clerk.test/v1/organization_roles/${roleId}/permissions/${permissionId}`,
 validateHeaders(() => HttpResponse.json(mockRole)),
 ),
 );

 const response = await apiClient.organizationRoles.removePermissionFromOrganizationRole({
 organizationRoleId: roleId,
 permissionId,
 });

 expect(response.id).toBe(roleId);
 });
});
Loading
Loading