SigNoz is an open-source, OpenTelemetry-native observability platform for your team and their AI agents. Get logs, metrics, and traces in one tool with features like APM, distributed tracing, log management, infra monitoring, etc. Combined with SigNoz MCP and a native AI teammate (in SigNoz Cloud) it helps you build more resilient apps.
TypeScript apmapplication-monitoringdistributed-tracinggogood-first-issuejaegerloglogsmetricsmonitoringnextjsobservabilityopen-sourceopentelemetryprometheusreactreactjsself-hostedtracingtypescript
feat(serviceaccount): assign roles through the service_account_roles API (#12589)
Vikrant Gupta014cab564e67
diff --git a/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.authz.test.tsx b/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.authz.test.tsxindex c02622ddab..8ace6d1c10 100644--- a/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.authz.test.tsx+++ b/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.authz.test.tsx@@ -1,4 +1,7 @@-import { listRolesSuccessResponse } from 'mocks-server/__mockdata__/roles';+import {+ listRolesSuccessResponse,+ managedRoles,+} from 'mocks-server/__mockdata__/roles';import { rest, server } from 'mocks-server/server';import { NuqsTestingAdapter } from 'nuqs/adapters/testing';import { fireEvent, render, screen, waitFor } from 'tests/test-utils';@@ -18,17 +21,24 @@ const ROLES_ENDPOINT = '*/api/v1/roles';const SA_KEYS_ENDPOINT = '*/api/v1/service_accounts/:id/keys';const SA_ENDPOINT = '*/api/v1/service_accounts/sa-1';const SA_DELETE_ENDPOINT = '*/api/v1/service_accounts/sa-1';-const SA_ROLES_ENDPOINT = '*/api/v1/service_accounts/:id/roles';-const SA_ROLE_DELETE_ENDPOINT = '*/api/v1/service_accounts/:id/roles/:rid';+const SA_ROLES_ENDPOINT = '*/api/v1/service_account_roles';+const SA_ROLE_DELETE_ENDPOINT = '*/api/v1/service_account_roles/:id';const activeAccountResponse = {id: 'sa-1',name: 'CI Bot',email: '[email protected]',- roles: ['signoz-admin'],status: 'ACTIVE',createdAt: '2026-01-01T00:00:00Z',updatedAt: '2026-01-02T00:00:00Z',+ serviceAccountRoles: [+ {+ id: 'sar-admin-1',+ serviceAccountId: 'sa-1',+ roleId: managedRoles[0].id,+ role: { ...managedRoles[0], transactionGroups: [] },+ },+ ],};function renderDrawer(@@ -58,22 +68,13 @@ function setupBaseHandlers(): void {rest.delete(SA_DELETE_ENDPOINT, (_, res, ctx) =>res(ctx.status(200), ctx.json({ status: 'success', data: {} })),),- rest.get(SA_ROLES_ENDPOINT, (_, res, ctx) =>+ rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) =>res(- ctx.status(200),- ctx.json({- data: listRolesSuccessResponse.data.filter(- (r) => r.name === 'signoz-admin',- ),- }),+ ctx.status(201),+ ctx.json({ status: 'success', data: { id: 'sar-new' } }),),),- rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ status: 'success', data: {} })),- ),- rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ status: 'success', data: {} })),- ),+ rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) => res(ctx.status(204))),);}diff --git a/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.test.tsx b/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.test.tsxindex 08fb632bda..18efebf2a0 100644--- a/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.test.tsx+++ b/frontend/src/components/ServiceAccountDrawer/__tests__/ServiceAccountDrawer.test.tsx@@ -1,4 +1,7 @@-import { listRolesSuccessResponse } from 'mocks-server/__mockdata__/roles';+import {+ listRolesSuccessResponse,+ managedRoles,+} from 'mocks-server/__mockdata__/roles';import { rest, server } from 'mocks-server/server';import { NuqsTestingAdapter } from 'nuqs/adapters/testing';import { render, screen, userEvent, waitFor } from 'tests/test-utils';@@ -10,23 +13,33 @@ const ROLES_ENDPOINT = '*/api/v1/roles';const SA_KEYS_ENDPOINT = '*/api/v1/service_accounts/:id/keys';const SA_ENDPOINT = '*/api/v1/service_accounts/sa-1';const SA_DELETE_ENDPOINT = '*/api/v1/service_accounts/sa-1';-const SA_ROLES_ENDPOINT = '*/api/v1/service_accounts/:id/roles';-const SA_ROLE_DELETE_ENDPOINT = '*/api/v1/service_accounts/:id/roles/:rid';+const SA_ROLES_ENDPOINT = '*/api/v1/service_account_roles';+const SA_ROLE_DELETE_ENDPOINT = '*/api/v1/service_account_roles/:id';++const ADMIN_ASSIGNMENT_ID = 'sar-admin-1';const activeAccountResponse = {id: 'sa-1',name: 'CI Bot',email: '[email protected]',- roles: ['signoz-admin'],status: 'ACTIVE',createdAt: '2026-01-01T00:00:00Z',updatedAt: '2026-01-02T00:00:00Z',+ serviceAccountRoles: [+ {+ id: ADMIN_ASSIGNMENT_ID,+ serviceAccountId: 'sa-1',+ roleId: managedRoles[0].id,+ role: { ...managedRoles[0], transactionGroups: [] },+ },+ ],};const deletedAccountResponse = {...activeAccountResponse,id: 'sa-2',status: 'DELETED',+ serviceAccountRoles: [],};function renderDrawer(@@ -58,22 +71,13 @@ describe('ServiceAccountDrawer', () => {rest.delete(SA_DELETE_ENDPOINT, (_, res, ctx) =>res(ctx.status(200), ctx.json({ status: 'success', data: {} })),),- rest.get(SA_ROLES_ENDPOINT, (_, res, ctx) =>+ rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) =>res(- ctx.status(200),- ctx.json({- data: listRolesSuccessResponse.data.filter(- (r) => r.name === 'signoz-admin',- ),- }),+ ctx.status(201),+ ctx.json({ status: 'success', data: { id: 'sar-new' } }),),),- rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ status: 'success', data: {} })),- ),- rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ status: 'success', data: {} })),- ),+ rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) => res(ctx.status(204))),setupAuthzAdmin(),);});@@ -136,11 +140,14 @@ describe('ServiceAccountDrawer', () => {server.use(rest.post(SA_ROLES_ENDPOINT, async (req, res, ctx) => {roleSpy(await req.json());- return res(ctx.status(200), ctx.json({ status: 'success', data: {} }));+ return res(+ ctx.status(201),+ ctx.json({ status: 'success', data: { id: 'sar-new' } }),+ );}),rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) => {deleteSpy();- return res(ctx.status(200), ctx.json({ status: 'success', data: {} }));+ return res(ctx.status(204));}),);@@ -159,7 +166,8 @@ describe('ServiceAccountDrawer', () => {await waitFor(() => {expect(roleSpy).toHaveBeenCalledWith(expect.objectContaining({- id: '019c24aa-2248-7585-a129-4188b3473c27',+ serviceAccountId: 'sa-1',+ roleId: '019c24aa-2248-7585-a129-4188b3473c27',}),);expect(deleteSpy).not.toHaveBeenCalled();@@ -174,11 +182,14 @@ describe('ServiceAccountDrawer', () => {server.use(rest.post(SA_ROLES_ENDPOINT, async (req, res, ctx) => {roleSpy(await req.json());- return res(ctx.status(200), ctx.json({ status: 'success', data: {} }));+ return res(+ ctx.status(201),+ ctx.json({ status: 'success', data: { id: 'sar-new' } }),+ );}),- rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) => {- deleteSpy();- return res(ctx.status(200), ctx.json({ status: 'success', data: {} }));+ rest.delete(SA_ROLE_DELETE_ENDPOINT, (req, res, ctx) => {+ deleteSpy(req.params.id);+ return res(ctx.status(204));}),);@@ -198,7 +209,7 @@ describe('ServiceAccountDrawer', () => {await user.click(saveBtn);await waitFor(() => {- expect(deleteSpy).toHaveBeenCalled();+ expect(deleteSpy).toHaveBeenCalledWith(ADMIN_ASSIGNMENT_ID);expect(roleSpy).not.toHaveBeenCalled();});});@@ -246,9 +257,6 @@ describe('ServiceAccountDrawer', () => {rest.get('*/api/v1/service_accounts/sa-2/keys', (_, res, ctx) =>res(ctx.status(200), ctx.json({ data: [] })),),- rest.get('*/api/v1/service_accounts/sa-2/roles', (_, res, ctx) =>- res(ctx.status(200), ctx.json({ data: [] })),- ),);renderDrawer({ account: 'sa-2' });@@ -312,22 +320,13 @@ describe('ServiceAccountDrawer – save-error UX', () => {rest.delete(SA_DELETE_ENDPOINT, (_, res, ctx) =>res(ctx.status(200), ctx.json({ status: 'success', data: {} })),),- rest.get(SA_ROLES_ENDPOINT, (_, res, ctx) =>+ rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) =>res(- ctx.status(200),- ctx.json({- data: listRolesSuccessResponse.data.filter(- (r) => r.name === 'signoz-admin',- ),- }),+ ctx.status(201),+ ctx.json({ status: 'success', data: { id: 'sar-new' } }),),),- rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ status: 'success', data: {} })),- ),- rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ status: 'success', data: {} })),- ),+ rest.delete(SA_ROLE_DELETE_ENDPOINT, (_, res, ctx) => res(ctx.status(204))),setupAuthzAdmin(),);});@@ -410,14 +409,17 @@ describe('ServiceAccountDrawer – save-error UX', () => {const user = userEvent.setup({ pointerEventsCheck: 0 });let roleAddCallCount = 0;- // First call → 429, second call → 200+ // First call → 429, second call → 201server.use(rest.post(SA_ROLES_ENDPOINT, (_, res, ctx) => {roleAddCallCount += 1;if (roleAddCallCount === 1) {return res(ctx.status(429), ctx.json({ message: 'Too Many Requests' }));}- return res(ctx.status(200), ctx.json({ status: 'success', data: {} }));+ return res(+ ctx.status(201),+ ctx.json({ status: 'success', data: { id: 'sar-new' } }),+ );}),);diff --git a/frontend/src/container/ServiceAccountsSettings/__tests__/ServiceAccountsSettings.authz.integration.test.tsx b/frontend/src/container/ServiceAccountsSettings/__tests__/ServiceAccountsSettings.authz.integration.test.tsxindex 88323441f3..464b821538 100644--- a/frontend/src/container/ServiceAccountsSettings/__tests__/ServiceAccountsSettings.authz.integration.test.tsx+++ b/frontend/src/container/ServiceAccountsSettings/__tests__/ServiceAccountsSettings.authz.integration.test.tsx@@ -10,7 +10,6 @@ import ServiceAccountsSettings from '../ServiceAccountsSettings';const SA_LIST_ENDPOINT = '*/api/v1/service_accounts';const SA_ENDPOINT = '*/api/v1/service_accounts/:id';const SA_KEYS_ENDPOINT = '*/api/v1/service_accounts/:id/keys';-const SA_ROLES_ENDPOINT = '*/api/v1/service_accounts/:id/roles';const ROLES_ENDPOINT = '*/api/v1/roles';const mockServiceAccountsAPI = [@@ -18,7 +17,7 @@ const mockServiceAccountsAPI = [id: 'sa-1',name: 'CI Bot',email: '[email protected]',- roles: ['signoz-admin'],+ serviceAccountRoles: [],status: 'ACTIVE',createdAt: 1700000000,updatedAt: 1700000001,@@ -27,7 +26,7 @@ const mockServiceAccountsAPI = [id: 'sa-2',name: 'Monitoring Agent',email: '[email protected]',- roles: ['signoz-viewer'],+ serviceAccountRoles: [],status: 'ACTIVE',createdAt: 1700000002,updatedAt: 1700000003,@@ -36,7 +35,7 @@ const mockServiceAccountsAPI = [id: 'sa-3',name: 'Legacy Bot',email: '[email protected]',- roles: ['signoz-editor'],+ serviceAccountRoles: [],status: 'DISABLED',createdAt: 1700000004,updatedAt: 1700000005,@@ -61,9 +60,6 @@ describe('ServiceAccountsSettings (integration)', () => {rest.get(SA_KEYS_ENDPOINT, (_, res, ctx) =>res(ctx.status(200), ctx.json({ data: [] })),),- rest.get(SA_ROLES_ENDPOINT, (_, res, ctx) =>- res(ctx.status(200), ctx.json({ data: [] })),- ),rest.get(ROLES_ENDPOINT, (_, res, ctx) =>res(ctx.status(200), ctx.json(listRolesSuccessResponse)),),diff --git a/frontend/src/hooks/serviceAccount/useServiceAccountRoleManager.ts b/frontend/src/hooks/serviceAccount/useServiceAccountRoleManager.tsindex 9cd379f1d1..d04fb468cc 100644--- a/frontend/src/hooks/serviceAccount/useServiceAccountRoleManager.ts+++ b/frontend/src/hooks/serviceAccount/useServiceAccountRoleManager.ts@@ -1,19 +1,23 @@import { useCallback, useMemo } from 'react';-import { useQueryClient } from 'react-query';import {- getGetServiceAccountRolesQueryKey,- useCreateServiceAccountRoleDeprecated,- useDeleteServiceAccountRoleDeprecated,- useGetServiceAccountRoles,+ useCreateServiceAccountRole,+ useDeleteServiceAccountRole,+ useGetServiceAccount,} from 'api/generated/services/serviceaccount';-import type { AuthtypesGettableRoleDTO } from 'api/generated/services/sigNoz.schemas';+import type {+ AuthtypesGettableRoleDTO,+ ServiceaccounttypesServiceAccountRoleDTO,+} from 'api/generated/services/sigNoz.schemas';import { retryOn429 } from 'utils/errorUtils';const enum PromiseStatus {- Fulfilled = 'fulfilled',Rejected = 'rejected',}+// Stable identity so the memos below do not recompute on every render.+const EMPTY_SERVICE_ACCOUNT_ROLES: ServiceaccounttypesServiceAccountRoleDTO[] =+ [];+export interface RoleUpdateFailure {roleName: string;error: unknown;@@ -33,34 +37,40 @@ export function useServiceAccountRoleManager(accountId: string,options?: { enabled?: boolean },): UseServiceAccountRoleManagerResult {- const queryClient = useQueryClient();-- const { data, isLoading } = useGetServiceAccountRoles(+ const { data, isLoading } = useGetServiceAccount({ id: accountId },{ query: { enabled: options?.enabled ?? true } },);+ const serviceAccountRoles =+ data?.data?.serviceAccountRoles ?? EMPTY_SERVICE_ACCOUNT_ROLES;+const currentRoles = useMemo<AuthtypesGettableRoleDTO[]>(- () => data?.data ?? [],- [data?.data],+ () =>+ serviceAccountRoles.map((serviceAccountRole) => serviceAccountRole.role),+ [serviceAccountRoles],+ );++ // DELETE /api/v1/service_account_roles/{id} is keyed by the join row, not the role.+ const assignmentIdByRoleId = useMemo(+ () =>+ new Map(+ serviceAccountRoles.map((serviceAccountRole) => [+ serviceAccountRole.roleId,+ serviceAccountRole.id,+ ]),+ ),+ [serviceAccountRoles],);// the retry for these mutations is safe due to being idempotent on backend- const { mutateAsync: createRole } = useCreateServiceAccountRoleDeprecated({+ const { mutateAsync: createRole } = useCreateServiceAccountRole({mutation: { retry: retryOn429 },});- const { mutateAsync: deleteRole } = useDeleteServiceAccountRoleDeprecated({+ const { mutateAsync: deleteRole } = useDeleteServiceAccountRole({mutation: { retry: retryOn429 },});- const invalidateRoles = useCallback(- () =>- queryClient.invalidateQueries(- getGetServiceAccountRolesQueryKey({ id: accountId }),- ),- [accountId, queryClient],- );-const applyDiff = useCallback(async (localRoleIds: string[],@@ -84,26 +94,34 @@ export function useServiceAccountRoleManager(...addedRoles.map((role) => ({role,run: (): ReturnType<typeof createRole> =>- createRole({ pathParams: { id: accountId }, data: { id: role.id } }),- })),- ...removedRoles.map((role) => ({- role,- run: (): ReturnType<typeof deleteRole> =>- deleteRole({ pathParams: { id: accountId, rid: role.id ?? '' } }),+ createRole({+ data: { serviceAccountId: accountId, roleId: role.id ?? '' },+ }),})),+ ...removedRoles+ .map((role) => ({+ role,+ assignmentId: assignmentIdByRoleId.get(role.id ?? ''),+ }))+ .filter(+ (+ entry,+ ): entry is {+ role: AuthtypesGettableRoleDTO;+ assignmentId: string;+ } => !!entry.assignmentId,+ )+ .map(({ role, assignmentId }) => ({+ role,+ run: (): ReturnType<typeof deleteRole> =>+ deleteRole({ pathParams: { id: assignmentId } }),+ })),];const results = await Promise.allSettled(allOperations.map((op) => op.run()),);- const successCount = results.filter(- (r) => r.status === PromiseStatus.Fulfilled,- ).length;- if (successCount > 0) {- await invalidateRoles();- }-const failures: RoleUpdateFailure[] = [];results.forEach((result, index) => {if (result.status === PromiseStatus.Rejected) {@@ -113,7 +131,6 @@ export function useServiceAccountRoleManager(error: result.reason,onRetry: async (): Promise<void> => {await run();- await invalidateRoles();},});}@@ -121,7 +138,7 @@ export function useServiceAccountRoleManager(return failures;},- [accountId, currentRoles, createRole, deleteRole, invalidateRoles],+ [accountId, currentRoles, assignmentIdByRoleId, createRole, deleteRole],);return {