Bed 3375 UI (#109)

* feat: add domainsid filtering to posture endpoint in bhe js client * chore: add types and sort by param to posture endpoint in js api client
SpecterOps · Sep 19, 2023 · b3fb3b7 · b3fb3b7
1 parent 4b8170c
commit b3fb3b7
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 7 deletions.
diff --git a/packages/javascript/js-client-library/src/client.ts b/packages/javascript/js-client-library/src/client.ts
@@ -16,7 +16,7 @@
 
 import axios, { AxiosInstance } from 'axios';
 import * as types from './types';
-import { CreateAuthTokenResponse, ListAuthTokensResponse } from './responses';
+import { CreateAuthTokenResponse, ListAuthTokensResponse, PostureResponse } from './responses';
 
 class BHEAPIClient {
     baseClient: AxiosInstance;
@@ -188,19 +188,25 @@ class BHEAPIClient {
         );
     };
 
-    getPostureStats = (from: Date, to: Date, options?: types.RequestOptions) =>
-        this.baseClient.get(
+    getPostureStats = (from: Date, to: Date, domainSID?: string, sortBy?: string, options?: types.RequestOptions) => {
+        const params: types.PostureRequest = {
+            from: from.toISOString(),
+            to: to.toISOString(),
+        };
+
+        if (domainSID) params.domain_sid = `eq:${domainSID}`;
+        if (sortBy) params.sort_by = sortBy;
+
+        return this.baseClient.get<PostureResponse>(
             '/api/v2/posture-stats',
             Object.assign(
                 {
-                    params: {
-                        from: from.toISOString(),
-                        to: to.toISOString(),
-                    },
+                    params: params,
                 },
                 options
             )
         );
+    };
 
     /* ingest */
     ingestData = (options?: types.RequestOptions) => this.baseClient.post('/api/v2/ingest', options);

diff --git a/packages/javascript/js-client-library/src/responses.ts b/packages/javascript/js-client-library/src/responses.ts
@@ -39,6 +39,16 @@ type TimestampFields = {
     };
 };
 
+type PostureStat = TimestampFields & {
+    domain_sid: string;
+    exposure_index: number;
+    tier_zero_count: number;
+    critical_risk_count: number;
+    id: number;
+};
+
+export type PostureResponse = PaginatedResponse<PostureStat[]>;
+
 export type AuthToken = TimestampFields & {
     hmac_method: string;
     id: string;

diff --git a/packages/javascript/js-client-library/src/types.ts b/packages/javascript/js-client-library/src/types.ts
@@ -141,6 +141,13 @@ export interface GetCollectorsResponse {
     };
 }
 
+export type PostureRequest = {
+    from: string;
+    to: string;
+    domain_sid?: string;
+    sort_by?: string;
+};
+
 export type GraphNode = {
     label: string;
     kind: string;