cloudflare 6.0.0 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/package.json +1 -1
- package/resources/aisearch/instances/instances.d.ts +42 -0
- package/resources/aisearch/instances/instances.d.ts.map +1 -1
- package/resources/aisearch/instances/instances.js.map +1 -1
- package/resources/aisearch/instances/instances.mjs.map +1 -1
- package/resources/aisearch/namespaces/instances/instances.d.ts +42 -0
- package/resources/aisearch/namespaces/instances/instances.d.ts.map +1 -1
- package/resources/aisearch/namespaces/instances/instances.js.map +1 -1
- package/resources/aisearch/namespaces/instances/instances.mjs.map +1 -1
- package/resources/billing/usage.d.ts +3 -1
- package/resources/billing/usage.d.ts.map +1 -1
- package/resources/email-security/submissions.d.ts +6 -0
- package/resources/email-security/submissions.d.ts.map +1 -1
- package/resources/email-security/submissions.js.map +1 -1
- package/resources/email-security/submissions.mjs.map +1 -1
- package/resources/intel/indicator-feeds/indicator-feeds.d.ts +91 -1
- package/resources/intel/indicator-feeds/indicator-feeds.d.ts.map +1 -1
- package/resources/intel/indicator-feeds/indicator-feeds.js.map +1 -1
- package/resources/intel/indicator-feeds/indicator-feeds.mjs.map +1 -1
- package/resources/radar/dns/dns.d.ts +3 -3
- package/resources/radar/dns/dns.d.ts.map +1 -1
- package/resources/radar/dns/dns.js.map +1 -1
- package/resources/radar/dns/dns.mjs.map +1 -1
- package/resources/security-center/insights/audit-logs.d.ts +192 -0
- package/resources/security-center/insights/audit-logs.d.ts.map +1 -0
- package/resources/security-center/insights/audit-logs.js +64 -0
- package/resources/security-center/insights/audit-logs.js.map +1 -0
- package/resources/security-center/insights/audit-logs.mjs +58 -0
- package/resources/security-center/insights/audit-logs.mjs.map +1 -0
- package/resources/security-center/insights/class.d.ts +8 -0
- package/resources/security-center/insights/class.d.ts.map +1 -1
- package/resources/security-center/insights/class.js.map +1 -1
- package/resources/security-center/insights/class.mjs.map +1 -1
- package/resources/security-center/insights/classification.d.ts +77 -0
- package/resources/security-center/insights/classification.d.ts.map +1 -0
- package/resources/security-center/insights/classification.js +43 -0
- package/resources/security-center/insights/classification.js.map +1 -0
- package/resources/security-center/insights/classification.mjs +39 -0
- package/resources/security-center/insights/classification.mjs.map +1 -0
- package/resources/security-center/insights/context.d.ts +31 -0
- package/resources/security-center/insights/context.d.ts.map +1 -0
- package/resources/security-center/insights/context.js +26 -0
- package/resources/security-center/insights/context.js.map +1 -0
- package/resources/security-center/insights/context.mjs +22 -0
- package/resources/security-center/insights/context.mjs.map +1 -0
- package/resources/security-center/insights/index.d.ts +3 -0
- package/resources/security-center/insights/index.d.ts.map +1 -1
- package/resources/security-center/insights/index.js +9 -1
- package/resources/security-center/insights/index.js.map +1 -1
- package/resources/security-center/insights/index.mjs +3 -0
- package/resources/security-center/insights/index.mjs.map +1 -1
- package/resources/security-center/insights/insights.d.ts +30 -0
- package/resources/security-center/insights/insights.d.ts.map +1 -1
- package/resources/security-center/insights/insights.js +22 -0
- package/resources/security-center/insights/insights.js.map +1 -1
- package/resources/security-center/insights/insights.mjs +22 -0
- package/resources/security-center/insights/insights.mjs.map +1 -1
- package/resources/security-center/insights/severity.d.ts +8 -0
- package/resources/security-center/insights/severity.d.ts.map +1 -1
- package/resources/security-center/insights/severity.js.map +1 -1
- package/resources/security-center/insights/severity.mjs.map +1 -1
- package/resources/security-center/insights/type.d.ts +7 -0
- package/resources/security-center/insights/type.d.ts.map +1 -1
- package/resources/security-center/insights/type.js.map +1 -1
- package/resources/security-center/insights/type.mjs.map +1 -1
- package/resources/zero-trust/access/logs/access-requests.d.ts +19 -8
- package/resources/zero-trust/access/logs/access-requests.d.ts.map +1 -1
- package/resources/zero-trust/access/logs/scim/updates.d.ts +20 -8
- package/resources/zero-trust/access/logs/scim/updates.d.ts.map +1 -1
- package/resources/zero-trust/access/logs/scim/updates.js.map +1 -1
- package/resources/zero-trust/access/logs/scim/updates.mjs.map +1 -1
- package/resources/zero-trust/devices/deployment-groups.d.ts +203 -0
- package/resources/zero-trust/devices/deployment-groups.d.ts.map +1 -0
- package/resources/zero-trust/devices/deployment-groups.js +111 -0
- package/resources/zero-trust/devices/deployment-groups.js.map +1 -0
- package/resources/zero-trust/devices/deployment-groups.mjs +106 -0
- package/resources/zero-trust/devices/deployment-groups.mjs.map +1 -0
- package/resources/zero-trust/devices/devices.d.ts +4 -0
- package/resources/zero-trust/devices/devices.d.ts.map +1 -1
- package/resources/zero-trust/devices/devices.js +5 -0
- package/resources/zero-trust/devices/devices.js.map +1 -1
- package/resources/zero-trust/devices/devices.mjs +5 -0
- package/resources/zero-trust/devices/devices.mjs.map +1 -1
- package/resources/zero-trust/devices/index.d.ts +1 -0
- package/resources/zero-trust/devices/index.d.ts.map +1 -1
- package/resources/zero-trust/devices/index.js +4 -1
- package/resources/zero-trust/devices/index.js.map +1 -1
- package/resources/zero-trust/devices/index.mjs +1 -0
- package/resources/zero-trust/devices/index.mjs.map +1 -1
- package/resources/zero-trust/identity-providers/scim/groups.d.ts +10 -4
- package/resources/zero-trust/identity-providers/scim/groups.d.ts.map +1 -1
- package/resources/zero-trust/identity-providers/scim/groups.js.map +1 -1
- package/resources/zero-trust/identity-providers/scim/groups.mjs.map +1 -1
- package/resources/zero-trust/identity-providers/scim/users.d.ts +10 -4
- package/resources/zero-trust/identity-providers/scim/users.d.ts.map +1 -1
- package/resources/zero-trust/identity-providers/scim/users.js.map +1 -1
- package/resources/zero-trust/identity-providers/scim/users.mjs.map +1 -1
- package/resources/zones/settings.d.ts +52 -2
- package/resources/zones/settings.d.ts.map +1 -1
- package/resources/zones/zones.d.ts +6 -0
- package/resources/zones/zones.d.ts.map +1 -1
- package/resources/zones/zones.js.map +1 -1
- package/resources/zones/zones.mjs.map +1 -1
- package/src/resources/aisearch/instances/instances.ts +49 -0
- package/src/resources/aisearch/namespaces/instances/instances.ts +49 -0
- package/src/resources/billing/usage.ts +3 -1
- package/src/resources/email-security/submissions.ts +7 -0
- package/src/resources/intel/indicator-feeds/indicator-feeds.ts +107 -1
- package/src/resources/radar/dns/dns.ts +7 -4
- package/src/resources/security-center/api.md +32 -0
- package/src/resources/security-center/insights/audit-logs.ts +313 -0
- package/src/resources/security-center/insights/class.ts +8 -0
- package/src/resources/security-center/insights/classification.ts +127 -0
- package/src/resources/security-center/insights/context.ts +46 -0
- package/src/resources/security-center/insights/index.ts +15 -0
- package/src/resources/security-center/insights/insights.ts +62 -0
- package/src/resources/security-center/insights/severity.ts +8 -0
- package/src/resources/security-center/insights/type.ts +7 -0
- package/src/resources/zero-trust/access/logs/access-requests.ts +19 -8
- package/src/resources/zero-trust/access/logs/scim/updates.ts +20 -8
- package/src/resources/zero-trust/api.md +15 -0
- package/src/resources/zero-trust/devices/deployment-groups.ts +302 -0
- package/src/resources/zero-trust/devices/devices.ts +29 -0
- package/src/resources/zero-trust/devices/index.ts +11 -0
- package/src/resources/zero-trust/identity-providers/scim/groups.ts +10 -4
- package/src/resources/zero-trust/identity-providers/scim/users.ts +10 -4
- package/src/resources/zones/settings.ts +60 -0
- package/src/resources/zones/zones.ts +7 -0
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../../resource';
|
|
4
|
+
import * as Core from '../../../core';
|
|
5
|
+
import { CloudflareError } from '../../../error';
|
|
6
|
+
|
|
7
|
+
export class Classification extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Updates the user classification for a Security Center insight. Valid values are
|
|
10
|
+
* 'false_positive' or 'accept_risk'. To reset, set classification to null. Cannot
|
|
11
|
+
* change directly between classification values - must reset to null first.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const classification =
|
|
16
|
+
* await client.securityCenter.insights.classification.update(
|
|
17
|
+
* 'issue_id',
|
|
18
|
+
* { account_id: 'account_id' },
|
|
19
|
+
* );
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
update(
|
|
23
|
+
issueId: string,
|
|
24
|
+
params: ClassificationUpdateParams,
|
|
25
|
+
options?: Core.RequestOptions,
|
|
26
|
+
): Core.APIPromise<ClassificationUpdateResponse> {
|
|
27
|
+
const { account_id, zone_id, ...body } = params;
|
|
28
|
+
if (!account_id && !zone_id) {
|
|
29
|
+
throw new CloudflareError('You must provide either account_id or zone_id.');
|
|
30
|
+
}
|
|
31
|
+
if (account_id && zone_id) {
|
|
32
|
+
throw new CloudflareError('You cannot provide both account_id and zone_id.');
|
|
33
|
+
}
|
|
34
|
+
const { accountOrZone, accountOrZoneId } =
|
|
35
|
+
account_id ?
|
|
36
|
+
{
|
|
37
|
+
accountOrZone: 'accounts',
|
|
38
|
+
accountOrZoneId: account_id,
|
|
39
|
+
}
|
|
40
|
+
: {
|
|
41
|
+
accountOrZone: 'zones',
|
|
42
|
+
accountOrZoneId: zone_id,
|
|
43
|
+
};
|
|
44
|
+
return this._client.patch(
|
|
45
|
+
`/${accountOrZone}/${accountOrZoneId}/security-center/insights/${issueId}/classification`,
|
|
46
|
+
{ body, ...options },
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export interface ClassificationUpdateResponse {
|
|
52
|
+
errors: Array<ClassificationUpdateResponse.Error>;
|
|
53
|
+
|
|
54
|
+
messages: Array<ClassificationUpdateResponse.Message>;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Whether the API call was successful.
|
|
58
|
+
*/
|
|
59
|
+
success: true;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export namespace ClassificationUpdateResponse {
|
|
63
|
+
export interface Error {
|
|
64
|
+
code: number;
|
|
65
|
+
|
|
66
|
+
message: string;
|
|
67
|
+
|
|
68
|
+
documentation_url?: string;
|
|
69
|
+
|
|
70
|
+
source?: Error.Source;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export namespace Error {
|
|
74
|
+
export interface Source {
|
|
75
|
+
pointer?: string;
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export interface Message {
|
|
80
|
+
code: number;
|
|
81
|
+
|
|
82
|
+
message: string;
|
|
83
|
+
|
|
84
|
+
documentation_url?: string;
|
|
85
|
+
|
|
86
|
+
source?: Message.Source;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export namespace Message {
|
|
90
|
+
export interface Source {
|
|
91
|
+
pointer?: string;
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export interface ClassificationUpdateParams {
|
|
97
|
+
/**
|
|
98
|
+
* Path param: The Account ID to use for this endpoint. Mutually exclusive with the
|
|
99
|
+
* Zone ID.
|
|
100
|
+
*/
|
|
101
|
+
account_id?: string;
|
|
102
|
+
|
|
103
|
+
/**
|
|
104
|
+
* Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
|
|
105
|
+
* Account ID.
|
|
106
|
+
*/
|
|
107
|
+
zone_id?: string;
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Body param: User-defined classification for the insight. Can be
|
|
111
|
+
* 'false_positive', 'accept_risk', 'other', or null.
|
|
112
|
+
*/
|
|
113
|
+
classification?: 'false_positive' | 'accept_risk' | 'other' | null;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Body param: Rationale for the classification change. Required when
|
|
117
|
+
* classification is 'accept_risk' or 'other'.
|
|
118
|
+
*/
|
|
119
|
+
rationale?: string;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
export declare namespace Classification {
|
|
123
|
+
export {
|
|
124
|
+
type ClassificationUpdateResponse as ClassificationUpdateResponse,
|
|
125
|
+
type ClassificationUpdateParams as ClassificationUpdateParams,
|
|
126
|
+
};
|
|
127
|
+
}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
|
|
3
|
+
import { APIResource } from '../../../resource';
|
|
4
|
+
import * as Core from '../../../core';
|
|
5
|
+
|
|
6
|
+
export class Context extends APIResource {
|
|
7
|
+
/**
|
|
8
|
+
* Returns the full context payload for an insight. This endpoint is used for
|
|
9
|
+
* insights with large payloads that are not included inline in the list response.
|
|
10
|
+
*
|
|
11
|
+
* @example
|
|
12
|
+
* ```ts
|
|
13
|
+
* const context =
|
|
14
|
+
* await client.securityCenter.insights.context.get(
|
|
15
|
+
* 'issue_id',
|
|
16
|
+
* { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
get(
|
|
21
|
+
issueId: string,
|
|
22
|
+
params: ContextGetParams,
|
|
23
|
+
options?: Core.RequestOptions,
|
|
24
|
+
): Core.APIPromise<ContextGetResponse> {
|
|
25
|
+
const { account_id } = params;
|
|
26
|
+
return (
|
|
27
|
+
this._client.get(
|
|
28
|
+
`/accounts/${account_id}/security-center/insights/${issueId}/context`,
|
|
29
|
+
options,
|
|
30
|
+
) as Core.APIPromise<{ result: ContextGetResponse }>
|
|
31
|
+
)._thenUnwrap((obj) => obj.result);
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export type ContextGetResponse = { [key: string]: unknown };
|
|
36
|
+
|
|
37
|
+
export interface ContextGetParams {
|
|
38
|
+
/**
|
|
39
|
+
* Identifier.
|
|
40
|
+
*/
|
|
41
|
+
account_id: string;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export declare namespace Context {
|
|
45
|
+
export { type ContextGetResponse as ContextGetResponse, type ContextGetParams as ContextGetParams };
|
|
46
|
+
}
|
|
@@ -1,6 +1,21 @@
|
|
|
1
1
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
2
|
|
|
3
|
+
export {
|
|
4
|
+
AuditLogListResponsesCursorPagination,
|
|
5
|
+
AuditLogListByInsightResponsesCursorPagination,
|
|
6
|
+
AuditLogs,
|
|
7
|
+
type AuditLogListResponse,
|
|
8
|
+
type AuditLogListByInsightResponse,
|
|
9
|
+
type AuditLogListParams,
|
|
10
|
+
type AuditLogListByInsightParams,
|
|
11
|
+
} from './audit-logs';
|
|
3
12
|
export { Class, type ClassGetResponse, type ClassGetParams } from './class';
|
|
13
|
+
export {
|
|
14
|
+
Classification,
|
|
15
|
+
type ClassificationUpdateResponse,
|
|
16
|
+
type ClassificationUpdateParams,
|
|
17
|
+
} from './classification';
|
|
18
|
+
export { Context, type ContextGetResponse, type ContextGetParams } from './context';
|
|
4
19
|
export {
|
|
5
20
|
InsightListResponsesV4PagePagination,
|
|
6
21
|
Insights,
|
|
@@ -4,8 +4,22 @@ import { APIResource } from '../../../resource';
|
|
|
4
4
|
import { isRequestOptions } from '../../../core';
|
|
5
5
|
import * as Core from '../../../core';
|
|
6
6
|
import * as IssuesAPI from '../../intel/attack-surface-report/issues';
|
|
7
|
+
import * as AuditLogsAPI from './audit-logs';
|
|
8
|
+
import {
|
|
9
|
+
AuditLogListByInsightParams,
|
|
10
|
+
AuditLogListByInsightResponse,
|
|
11
|
+
AuditLogListByInsightResponsesCursorPagination,
|
|
12
|
+
AuditLogListParams,
|
|
13
|
+
AuditLogListResponse,
|
|
14
|
+
AuditLogListResponsesCursorPagination,
|
|
15
|
+
AuditLogs,
|
|
16
|
+
} from './audit-logs';
|
|
7
17
|
import * as ClassAPI from './class';
|
|
8
18
|
import { Class, ClassGetParams, ClassGetResponse } from './class';
|
|
19
|
+
import * as ClassificationAPI from './classification';
|
|
20
|
+
import { Classification, ClassificationUpdateParams, ClassificationUpdateResponse } from './classification';
|
|
21
|
+
import * as ContextAPI from './context';
|
|
22
|
+
import { Context, ContextGetParams, ContextGetResponse } from './context';
|
|
9
23
|
import * as SeverityAPI from './severity';
|
|
10
24
|
import { Severity, SeverityGetParams, SeverityGetResponse } from './severity';
|
|
11
25
|
import * as TypeAPI from './type';
|
|
@@ -17,10 +31,23 @@ export class Insights extends APIResource {
|
|
|
17
31
|
class: ClassAPI.Class = new ClassAPI.Class(this._client);
|
|
18
32
|
severity: SeverityAPI.Severity = new SeverityAPI.Severity(this._client);
|
|
19
33
|
type: TypeAPI.Type = new TypeAPI.Type(this._client);
|
|
34
|
+
auditLogs: AuditLogsAPI.AuditLogs = new AuditLogsAPI.AuditLogs(this._client);
|
|
35
|
+
classification: ClassificationAPI.Classification = new ClassificationAPI.Classification(this._client);
|
|
36
|
+
context: ContextAPI.Context = new ContextAPI.Context(this._client);
|
|
20
37
|
|
|
21
38
|
/**
|
|
22
39
|
* Lists all Security Center insights for the account or zone, showing security
|
|
23
40
|
* findings and recommendations.
|
|
41
|
+
*
|
|
42
|
+
* @example
|
|
43
|
+
* ```ts
|
|
44
|
+
* // Automatically fetches more pages as needed.
|
|
45
|
+
* for await (const insightListResponse of client.securityCenter.insights.list(
|
|
46
|
+
* { account_id: 'account_id' },
|
|
47
|
+
* )) {
|
|
48
|
+
* // ...
|
|
49
|
+
* }
|
|
50
|
+
* ```
|
|
24
51
|
*/
|
|
25
52
|
list(
|
|
26
53
|
params?: InsightListParams,
|
|
@@ -63,6 +90,14 @@ export class Insights extends APIResource {
|
|
|
63
90
|
/**
|
|
64
91
|
* Archives a Security Center insight for an account or zone, removing it from the
|
|
65
92
|
* active insights list while preserving historical data.
|
|
93
|
+
*
|
|
94
|
+
* @example
|
|
95
|
+
* ```ts
|
|
96
|
+
* const response =
|
|
97
|
+
* await client.securityCenter.insights.dismiss('issue_id', {
|
|
98
|
+
* account_id: 'account_id',
|
|
99
|
+
* });
|
|
100
|
+
* ```
|
|
66
101
|
*/
|
|
67
102
|
dismiss(
|
|
68
103
|
issueId: string,
|
|
@@ -305,6 +340,11 @@ Insights.InsightListResponsesV4PagePagination = InsightListResponsesV4PagePagina
|
|
|
305
340
|
Insights.Class = Class;
|
|
306
341
|
Insights.Severity = Severity;
|
|
307
342
|
Insights.Type = Type;
|
|
343
|
+
Insights.AuditLogs = AuditLogs;
|
|
344
|
+
Insights.AuditLogListResponsesCursorPagination = AuditLogListResponsesCursorPagination;
|
|
345
|
+
Insights.AuditLogListByInsightResponsesCursorPagination = AuditLogListByInsightResponsesCursorPagination;
|
|
346
|
+
Insights.Classification = Classification;
|
|
347
|
+
Insights.Context = Context;
|
|
308
348
|
|
|
309
349
|
export declare namespace Insights {
|
|
310
350
|
export {
|
|
@@ -324,4 +364,26 @@ export declare namespace Insights {
|
|
|
324
364
|
};
|
|
325
365
|
|
|
326
366
|
export { Type as Type, type TypeGetResponse as TypeGetResponse, type TypeGetParams as TypeGetParams };
|
|
367
|
+
|
|
368
|
+
export {
|
|
369
|
+
AuditLogs as AuditLogs,
|
|
370
|
+
type AuditLogListResponse as AuditLogListResponse,
|
|
371
|
+
type AuditLogListByInsightResponse as AuditLogListByInsightResponse,
|
|
372
|
+
AuditLogListResponsesCursorPagination as AuditLogListResponsesCursorPagination,
|
|
373
|
+
AuditLogListByInsightResponsesCursorPagination as AuditLogListByInsightResponsesCursorPagination,
|
|
374
|
+
type AuditLogListParams as AuditLogListParams,
|
|
375
|
+
type AuditLogListByInsightParams as AuditLogListByInsightParams,
|
|
376
|
+
};
|
|
377
|
+
|
|
378
|
+
export {
|
|
379
|
+
Classification as Classification,
|
|
380
|
+
type ClassificationUpdateResponse as ClassificationUpdateResponse,
|
|
381
|
+
type ClassificationUpdateParams as ClassificationUpdateParams,
|
|
382
|
+
};
|
|
383
|
+
|
|
384
|
+
export {
|
|
385
|
+
Context as Context,
|
|
386
|
+
type ContextGetResponse as ContextGetResponse,
|
|
387
|
+
type ContextGetParams as ContextGetParams,
|
|
388
|
+
};
|
|
327
389
|
}
|
|
@@ -10,6 +10,14 @@ export class Severity extends APIResource {
|
|
|
10
10
|
/**
|
|
11
11
|
* Retrieves Security Center insight counts aggregated by severity level (critical,
|
|
12
12
|
* high, medium, low).
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* const severities =
|
|
17
|
+
* await client.securityCenter.insights.severity.get({
|
|
18
|
+
* account_id: 'account_id',
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
13
21
|
*/
|
|
14
22
|
get(params?: SeverityGetParams, options?: Core.RequestOptions): Core.APIPromise<SeverityGetResponse>;
|
|
15
23
|
get(options?: Core.RequestOptions): Core.APIPromise<SeverityGetResponse>;
|
|
@@ -9,6 +9,13 @@ import { CloudflareError } from '../../../error';
|
|
|
9
9
|
export class Type extends APIResource {
|
|
10
10
|
/**
|
|
11
11
|
* Retrieves Security Center insight counts aggregated by insight type.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const types = await client.securityCenter.insights.type.get(
|
|
16
|
+
* { account_id: 'account_id' },
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
12
19
|
*/
|
|
13
20
|
get(params?: TypeGetParams, options?: Core.RequestOptions): Core.APIPromise<TypeGetResponse>;
|
|
14
21
|
get(options?: Core.RequestOptions): Core.APIPromise<TypeGetResponse>;
|
|
@@ -64,10 +64,17 @@ export interface AccessRequestListParams {
|
|
|
64
64
|
direction?: 'desc' | 'asc';
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
|
-
* Query param: Filter by user email.
|
|
68
|
-
*
|
|
69
|
-
*
|
|
70
|
-
* `
|
|
67
|
+
* Query param: Filter by user email. Match mode is controlled by `emailOp`
|
|
68
|
+
* (preferred) or the legacy `email_exact` flag.
|
|
69
|
+
*
|
|
70
|
+
* - Default (no `emailOp`, `email_exact=false` or unset): substring match —
|
|
71
|
+
* `email=@example.com` returns all events with that domain.
|
|
72
|
+
* - Exact match: set `emailOp=eq` (preferred) or `email_exact=true` — e.g.
|
|
73
|
+
* `email=user@example.com&email_exact=true` returns only that user.
|
|
74
|
+
* - Explicit substring match: set `emailOp=contains` (without `email_exact=true`).
|
|
75
|
+
* When both are set, `email_exact=true` takes precedence and the match is exact.
|
|
76
|
+
* - Exclusion: set `emailOp=neq`. With `email_exact=true` this is an exact-value
|
|
77
|
+
* exclusion; without it, a fuzzy substring exclusion.
|
|
71
78
|
*/
|
|
72
79
|
email?: string;
|
|
73
80
|
|
|
@@ -78,9 +85,11 @@ export interface AccessRequestListParams {
|
|
|
78
85
|
email_exact?: boolean;
|
|
79
86
|
|
|
80
87
|
/**
|
|
81
|
-
* Query param: Operator for the `email` filter.
|
|
88
|
+
* Query param: Operator for the `email` filter. `contains` performs a substring
|
|
89
|
+
* (case-sensitive) match. When `email_exact=true` is also set, `email_exact` takes
|
|
90
|
+
* precedence and `contains` is ignored.
|
|
82
91
|
*/
|
|
83
|
-
emailOp?: 'eq' | 'neq';
|
|
92
|
+
emailOp?: 'eq' | 'neq' | 'contains';
|
|
84
93
|
|
|
85
94
|
/**
|
|
86
95
|
* Query param: Comma-separated list of fields to include in the response. When
|
|
@@ -129,12 +138,14 @@ export interface AccessRequestListParams {
|
|
|
129
138
|
until?: string;
|
|
130
139
|
|
|
131
140
|
/**
|
|
132
|
-
* Query param:
|
|
141
|
+
* Query param: Deprecated. Accepted for backward compatibility but no longer
|
|
142
|
+
* applied as a filter. Use `email` instead.
|
|
133
143
|
*/
|
|
134
144
|
user_id?: string;
|
|
135
145
|
|
|
136
146
|
/**
|
|
137
|
-
* Query param:
|
|
147
|
+
* Query param: Deprecated. Accepted for backward compatibility but no longer
|
|
148
|
+
* applied as a filter (the `user_id` parameter is itself deprecated).
|
|
138
149
|
*/
|
|
139
150
|
user_idOp?: 'eq' | 'neq';
|
|
140
151
|
}
|
|
@@ -108,9 +108,12 @@ export interface UpdateListParams extends V4PagePaginationArrayParams {
|
|
|
108
108
|
idp_id: Array<string>;
|
|
109
109
|
|
|
110
110
|
/**
|
|
111
|
-
* Query param: The unique Cloudflare-generated Id of the SCIM resource.
|
|
111
|
+
* Query param: The unique Cloudflare-generated Id of the SCIM resource. Pass once
|
|
112
|
+
* for a single lookup (`?cf_resource_id=A`) or repeat the parameter
|
|
113
|
+
* (`?cf_resource_id=A&cf_resource_id=B`) to filter by multiple resources in one
|
|
114
|
+
* request.
|
|
112
115
|
*/
|
|
113
|
-
cf_resource_id?: string
|
|
116
|
+
cf_resource_id?: Array<string>;
|
|
114
117
|
|
|
115
118
|
/**
|
|
116
119
|
* Query param: The chronological order used to sort the logs.
|
|
@@ -118,9 +121,12 @@ export interface UpdateListParams extends V4PagePaginationArrayParams {
|
|
|
118
121
|
direction?: 'desc' | 'asc';
|
|
119
122
|
|
|
120
123
|
/**
|
|
121
|
-
* Query param: The IdP-generated Id of the SCIM resource.
|
|
124
|
+
* Query param: The IdP-generated Id of the SCIM resource. Pass once for a single
|
|
125
|
+
* lookup (`?idp_resource_id=A`) or repeat the parameter
|
|
126
|
+
* (`?idp_resource_id=A&idp_resource_id=B`) to filter by multiple resources in one
|
|
127
|
+
* request.
|
|
122
128
|
*/
|
|
123
|
-
idp_resource_id?: string
|
|
129
|
+
idp_resource_id?: Array<string>;
|
|
124
130
|
|
|
125
131
|
/**
|
|
126
132
|
* Query param: The maximum number of update logs to retrieve.
|
|
@@ -133,9 +139,12 @@ export interface UpdateListParams extends V4PagePaginationArrayParams {
|
|
|
133
139
|
request_method?: Array<'DELETE' | 'PATCH' | 'POST' | 'PUT'>;
|
|
134
140
|
|
|
135
141
|
/**
|
|
136
|
-
* Query param: The display name of the SCIM Group resource.
|
|
142
|
+
* Query param: The display name of the SCIM Group resource. Pass once for a single
|
|
143
|
+
* lookup (`?resource_group_name=A`) or repeat the parameter
|
|
144
|
+
* (`?resource_group_name=A&resource_group_name=B`) to filter by multiple group
|
|
145
|
+
* names in one request.
|
|
137
146
|
*/
|
|
138
|
-
resource_group_name?: string
|
|
147
|
+
resource_group_name?: Array<string>;
|
|
139
148
|
|
|
140
149
|
/**
|
|
141
150
|
* Query param: The resource type of the SCIM request.
|
|
@@ -143,9 +152,12 @@ export interface UpdateListParams extends V4PagePaginationArrayParams {
|
|
|
143
152
|
resource_type?: Array<'USER' | 'GROUP'>;
|
|
144
153
|
|
|
145
154
|
/**
|
|
146
|
-
* Query param: The email address of the SCIM User resource.
|
|
155
|
+
* Query param: The email address of the SCIM User resource. Pass once for a single
|
|
156
|
+
* lookup (`?resource_user_email=A`) or repeat the parameter
|
|
157
|
+
* (`?resource_user_email=A&resource_user_email=B`) to filter by multiple emails in
|
|
158
|
+
* one request.
|
|
147
159
|
*/
|
|
148
|
-
resource_user_email?: string
|
|
160
|
+
resource_user_email?: Array<string>;
|
|
149
161
|
|
|
150
162
|
/**
|
|
151
163
|
* Query param: the timestamp of the earliest update log.
|
|
@@ -97,6 +97,21 @@ Methods:
|
|
|
97
97
|
- <code title="delete /accounts/{account_id}/devices/ip-profiles/{profile_id}">client.zeroTrust.devices.ipProfiles.<a href="./src/resources/zero-trust/devices/ip-profiles.ts">delete</a>(profileId, { ...params }) -> IPProfileDeleteResponse</code>
|
|
98
98
|
- <code title="get /accounts/{account_id}/devices/ip-profiles/{profile_id}">client.zeroTrust.devices.ipProfiles.<a href="./src/resources/zero-trust/devices/ip-profiles.ts">get</a>(profileId, { ...params }) -> IPProfile</code>
|
|
99
99
|
|
|
100
|
+
### DeploymentGroups
|
|
101
|
+
|
|
102
|
+
Types:
|
|
103
|
+
|
|
104
|
+
- <code><a href="./src/resources/zero-trust/devices/deployment-groups.ts">DeploymentGroup</a></code>
|
|
105
|
+
- <code><a href="./src/resources/zero-trust/devices/deployment-groups.ts">DeploymentGroupDeleteResponse</a></code>
|
|
106
|
+
|
|
107
|
+
Methods:
|
|
108
|
+
|
|
109
|
+
- <code title="post /accounts/{account_id}/devices/deployment-groups">client.zeroTrust.devices.deploymentGroups.<a href="./src/resources/zero-trust/devices/deployment-groups.ts">create</a>({ ...params }) -> DeploymentGroup</code>
|
|
110
|
+
- <code title="get /accounts/{account_id}/devices/deployment-groups">client.zeroTrust.devices.deploymentGroups.<a href="./src/resources/zero-trust/devices/deployment-groups.ts">list</a>({ ...params }) -> DeploymentGroupsV4PagePaginationArray</code>
|
|
111
|
+
- <code title="delete /accounts/{account_id}/devices/deployment-groups/{group_id}">client.zeroTrust.devices.deploymentGroups.<a href="./src/resources/zero-trust/devices/deployment-groups.ts">delete</a>(groupId, { ...params }) -> DeploymentGroupDeleteResponse</code>
|
|
112
|
+
- <code title="patch /accounts/{account_id}/devices/deployment-groups/{group_id}">client.zeroTrust.devices.deploymentGroups.<a href="./src/resources/zero-trust/devices/deployment-groups.ts">edit</a>(groupId, { ...params }) -> DeploymentGroup</code>
|
|
113
|
+
- <code title="get /accounts/{account_id}/devices/deployment-groups/{group_id}">client.zeroTrust.devices.deploymentGroups.<a href="./src/resources/zero-trust/devices/deployment-groups.ts">get</a>(groupId, { ...params }) -> DeploymentGroup</code>
|
|
114
|
+
|
|
100
115
|
### Networks
|
|
101
116
|
|
|
102
117
|
Types:
|