cloudflare
Version:
The official TypeScript library for the Cloudflare API
41 lines • 1.35 kB
text/typescript
import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseSummary extends APIResource {
static readonly _key: readonly ['zeroTrust', 'riskScoring', 'summary'];
/**
* Gets an aggregate summary of risk scores across the account, including
* distribution and trends.
*
* @example
* ```ts
* const summary =
* await client.zeroTrust.riskScoring.summary.get({
* account_id: 'account_id',
* });
* ```
*/
get(params: SummaryGetParams, options?: RequestOptions): APIPromise<SummaryGetResponse>;
}
export declare class Summary extends BaseSummary {
}
export interface SummaryGetResponse {
users: Array<SummaryGetResponse.User>;
}
export declare namespace SummaryGetResponse {
interface User {
email: string;
event_count: number;
last_event: string;
max_risk_level: 'low' | 'medium' | 'high';
name: string;
user_id: string;
}
}
export interface SummaryGetParams {
account_id: string;
}
export declare namespace Summary {
export { type SummaryGetResponse as SummaryGetResponse, type SummaryGetParams as SummaryGetParams };
}
//# sourceMappingURL=summary.d.mts.map