added tenant get/set settings (#334)

added password tenant get/set settings
added to readme
added tests

README.md

@@ -524,7 +524,7 @@ const descopeClient = DescopeClient({
 
 ### Manage Tenants
 
-You can create, update, delete or load tenants:
+You can create, update, delete or load tenants, as well as read and update tenant settings:
 
 ```typescript
 // The self provisioning domains or optional. If given they'll be used to associate
@@ -563,6 +563,49 @@ const searchRes = await descopeClient.management.tenant.searchAll(['id']);
 searchRes.data.forEach((tenant) => {
   // do something
 });
+
+// Load tenant settings by id
+const tenantSettings = await descopeClient.management.tenant.getSettings('my-tenant-id');
+
+// Update will override all fields as is. Use carefully.
+await descopeClient.management.tenant.configureSettings('my-tenant-id', {
+  domains: ['domain1.com'],
+  selfProvisioningDomains: ['domain1.com'],
+  sessionSettingsEnabled: true,
+  refreshTokenExpiration: 12,
+  refreshTokenExpirationUnit: 'days',
+  sessionTokenExpiration: 10,
+  sessionTokenExpirationUnit: 'minutes',
+  enableInactivity: true,
+  JITDisabled: false,
+  InactivityTime: 10,
+  InactivityTimeUnit: 'minutes',
+});
+```
+
+### Manage Password
+
+You can read and update any tenant password settings and policy:
+
+```typescript
+// Load tenant password settings by id
+const passwordSettings = await descopeClient.management.password.getSettings('my-tenant-id');
+
+// Update will override all fields as is. Use carefully.
+await descopeClient.management.password.configureSettings('my-tenant-id', {
+  enabled: true,
+  minLength: 8,
+  expiration: true,
+  expirationWeeks: 4,
+  lock: true,
+  lockAttempts: 5,
+  reuse: true,
+  reuseAmount: 6,
+  lowercase: true,
+  uppercase: false,
+  number: true,
+  nonAlphaNumeric: false,
+});
 ```
 
 ### Manage SSO applications

examples/managementCli/src/index.ts

@@ -296,6 +296,26 @@ program
     handleSdkRes(await sdk.management.tenant.loadAll());
   });
 
+// tenant-settings
+program
+  .command('tenant-settings')
+  .description('Load tenant settings by id')
+  .argument('<id>', 'Tenant ID')
+  .action(async (id) => {
+    handleSdkRes(await sdk.management.tenant.getSettings(id));
+  });
+
+// *** Password commands ***
+
+// password-settings
+program
+  .command('password-settings')
+  .description('Load password settings by tenant id')
+  .argument('<tenant-id>', 'Tenant ID')
+  .action(async (tenantId) => {
+    handleSdkRes(await sdk.management.password.getSettings(tenantId));
+  });
+
 // *** SSO application commands ***
 
 // sso-application-create-oidc

lib/management/index.ts

@@ -13,6 +13,7 @@ import WithTheme from './theme';
 import WithAudit from './audit';
 import WithAuthz from './authz';
 import withSSOApplication from './ssoapplication';
+import withPassword from './password';
 
 /** Constructs a higher level Management API that wraps the functions from code-js-sdk */
 const withManagement = (sdk: CoreSdk, managementKey?: string) => ({
@@ -24,6 +25,7 @@ const withManagement = (sdk: CoreSdk, managementKey?: string) => ({
   sso: withSSOSettings(sdk, managementKey),
   jwt: withJWT(sdk, managementKey),
   permission: withPermission(sdk, managementKey),
+  password: withPassword(sdk, managementKey),
   role: withRole(sdk, managementKey),
   group: withGroup(sdk, managementKey),
   flow: WithFlow(sdk, managementKey),

lib/management/password.test.ts

@@ -0,0 +1,91 @@
+import { SdkResponse } from '@descope/core-js-sdk';
+import withManagement from '.';
+import apiPaths from './paths';
+import { PasswordSettings } from './types';
+import { mockCoreSdk, mockHttpClient } from './testutils';
+
+const management = withManagement(mockCoreSdk, 'key');
+
+const mockPasswordSettings: PasswordSettings = {
+  enabled: true,
+  minLength: 8,
+  expiration: true,
+  expirationWeeks: 4,
+  lock: true,
+  lockAttempts: 5,
+  reuse: true,
+  reuseAmount: 6,
+  lowercase: true,
+  uppercase: false,
+  number: true,
+  nonAlphaNumeric: false,
+};
+
+describe('Management Password', () => {
+  afterEach(() => {
+    jest.clearAllMocks();
+    mockHttpClient.reset();
+  });
+
+  describe('getSettings', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => mockPasswordSettings,
+        clone: () => ({
+          json: () => Promise.resolve(mockPasswordSettings),
+        }),
+        status: 200,
+      };
+      mockHttpClient.get.mockResolvedValue(httpResponse);
+
+      const resp: SdkResponse<PasswordSettings> = await management.password.getSettings('test');
+
+      expect(mockHttpClient.get).toHaveBeenCalledWith(apiPaths.password.settings, {
+        queryParams: { tenantId: 'test' },
+        token: 'key',
+      });
+
+      expect(resp).toEqual({
+        code: 200,
+        data: mockPasswordSettings,
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
+
+  describe('configureSettings', () => {
+    it('should send the correct request and receive correct response', async () => {
+      const httpResponse = {
+        ok: true,
+        json: () => {},
+        clone: () => ({
+          json: () => Promise.resolve(),
+        }),
+        status: 200,
+      };
+      mockHttpClient.post.mockResolvedValue(httpResponse);
+
+      const resp: SdkResponse<never> = await management.password.configureSettings(
+        'test',
+        mockPasswordSettings,
+      );
+
+      expect(mockHttpClient.post).toHaveBeenCalledWith(
+        apiPaths.password.settings,
+        { ...mockPasswordSettings, tenantId: 'test' },
+        {
+          token: 'key',
+        },
+      );
+
+      expect(resp).toEqual({
+        code: 200,
+        data: undefined,
+        ok: true,
+        response: httpResponse,
+      });
+    });
+  });
+});

lib/management/password.ts

@@ -0,0 +1,27 @@
+import { SdkResponse, transformResponse } from '@descope/core-js-sdk';
+import { CoreSdk } from '../types';
+import apiPaths from './paths';
+import { PasswordSettings } from './types';
+
+const withPassword = (sdk: CoreSdk, managementKey?: string) => ({
+  getSettings: (tenantId: string): Promise<SdkResponse<PasswordSettings>> =>
+    transformResponse<PasswordSettings, PasswordSettings>(
+      sdk.httpClient.get(apiPaths.password.settings, {
+        queryParams: { tenantId },
+        token: managementKey,
+      }),
+      (data) => data,
+    ),
+  configureSettings: (tenantId: string, settings: PasswordSettings): Promise<SdkResponse<never>> =>
+    transformResponse(
+      sdk.httpClient.post(
+        apiPaths.password.settings,
+        { ...settings, tenantId },
+        {
+          token: managementKey,
+        },
+      ),
+    ),
+});
+
+export default withPassword;

lib/management/paths.ts

@@ -54,6 +54,7 @@ export default {
     update: '/v1/mgmt/tenant/update',
     delete: '/v1/mgmt/tenant/delete',
     load: '/v1/mgmt/tenant',
+    settings: '/v1/mgmt/tenant/settings',
     loadAll: '/v1/mgmt/tenant/all',
     searchAll: '/v1/mgmt/tenant/search',
   },
@@ -82,6 +83,9 @@ export default {
   jwt: {
     update: '/v1/mgmt/jwt/update',
   },
+  password: {
+    settings: '/v1/mgmt/password/settings',
+  },
   permission: {
     create: '/v1/mgmt/permission/create',
     update: '/v1/mgmt/permission/update',