Search roles (#343)

* search roles

* readme

README.md

@@ -932,6 +932,15 @@ const rolesRes = await descopeClient.management.role.loadAll();
 rolesRes.data.forEach((role) => {
   // do something
 });
+
+// Search roles
+const rolesRes = await descopeClient.management.role.search({
+  tenantIds: ['t1', 't2'],
+  roleNames: ['role1'],
+});
+rolesRes.data.forEach((role) => {
+  // do something
+});
 ```
 
 ### Query SSO Groups

lib/management/paths.ts

@@ -100,6 +100,7 @@ export default {
     update: '/v1/mgmt/role/update',
     delete: '/v1/mgmt/role/delete',
     loadAll: '/v1/mgmt/role/all',
+    search: '/v1/mgmt/role/search',
   },
   flow: {
     list: '/v1/mgmt/flow/list',

lib/management/role.test.ts

@@ -2,7 +2,7 @@ import { SdkResponse } from '@descope/core-js-sdk';
 import withManagement from '.';
 import apiPaths from './paths';
 import { mockCoreSdk, mockHttpClient } from './testutils';
-import { Role } from './types';
+import { Role, RoleSearchOptions } from './types';
 
 const management = withManagement(mockCoreSdk, 'key');
 
@@ -157,4 +157,36 @@ describe('Management Role', () => {
       });
     });
   });
+
+  describe('search', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => mockAllRolesResponse,
+        clone: () => ({
+          json: () => Promise.resolve(mockAllRolesResponse),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+      const req: RoleSearchOptions = {
+        tenantIds: ['t'],
+        roleNames: ['r'],
+        roleNameLike: 'x',
+        permissionNames: ['p'],
+      };
+      const resp: SdkResponse<Role[]> = await management.role.search(req);
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(apiPaths.role.search, req, {
+        token: 'key',
+      });
+
+      expect(resp).toEqual({
+        code: 200,
+        data: mockRoles,
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
 });

lib/management/role.ts

@@ -1,7 +1,7 @@
 import { SdkResponse, transformResponse } from '@descope/core-js-sdk';
 import { CoreSdk } from '../types';
 import apiPaths from './paths';
-import { Role } from './types';
+import { Role, RoleSearchOptions } from './types';
 
 type MultipleRoleResponse = {
   roles: Role[];
@@ -46,6 +46,13 @@ const withRole = (sdk: CoreSdk, managementKey?: string) => ({
       }),
       (data) => data.roles,
     ),
+  search: (options: RoleSearchOptions): Promise<SdkResponse<Role[]>> =>
+    transformResponse<MultipleRoleResponse, Role[]>(
+      sdk.httpClient.post(apiPaths.role.search, options, {
+        token: managementKey,
+      }),
+      (data) => data.roles,
+    ),
 });
 
 export default withRole;

lib/management/types.ts

@@ -236,6 +236,14 @@ export type Role = {
   tenantId?: string;
 };
 
+/** Search roles based on the parameters */
+export type RoleSearchOptions = {
+  tenantIds?: string[];
+  roleNames?: string[];
+  roleNameLike?: string; // Search roles where name contains this - case insensitive
+  permissionNames?: string[];
+};
+
 /** Represents a group in a project. It has an id and display name and a list of group members. */
 export type Group = {
   id: string;