Skip to content

Commit eb1005f

Browse files
author
Document Maintainer Bot
committed
20250716-1556.aac17a0217
1 parent 9e62cd8 commit eb1005f

15 files changed

+86
-70
lines changed

‎saas-restapi-v3/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- [Agent](<./agent/Agent/README.md>)
1111
- [Agent session](<./agent/Agent session/README.md>)
1212
- APPLICATION
13+
- [Application Activity](<./application/Application Activity/README.md>)
1314
- [Application Assess Rule Environment Configs](<./application/Application Assess Rule Environment Configs/README.md>)
1415
- [Application Components](<./application/Application Components/README.md>)
1516
- [Application Coverage](<./application/Application Coverage/README.md>)
@@ -23,7 +24,6 @@
2324
- [Application Vulnerability Filtering](<./application/Application Vulnerability Filtering/README.md>)
2425
- [Applications](<./application/Applications/README.md>)
2526
- [Assess Rule Configuration](<./application/Assess Rule Configuration/README.md>)
26-
- [Application Activity](<./application/Application Activity/README.md>)
2727
- APPLICATION SECURITY SUMMARY
2828
- [Application security summary](<./application security summary/Application security summary/README.md>)
2929
- AUTHENTICATION
@@ -69,8 +69,8 @@
6969
- [Organization admin approval workflow for vulnerability status](<./organization/Organization admin approval workflow for vulnerability status/README.md>)
7070
- [Organization feature](<./organization/Organization feature/README.md>)
7171
- [Organization time to remediate properties](<./organization/Organization time to remediate properties/README.md>)
72-
- [Organizations](<./organization/Organizations/README.md>)
7372
- [Search](<./organization/Search/README.md>)
73+
- [Organizations](<./organization/Organizations/README.md>)
7474
- PIVOTAL
7575
- PROFILE
7676
- [Profile](<./profile/Profile/README.md>)
@@ -110,10 +110,10 @@
110110
- [Organization Vulnerabilities Filters](<./trace/Organization Vulnerabilities Filters/README.md>)
111111
- [Organization Vulnerability Bulk Share](<./trace/Organization Vulnerability Bulk Share/README.md>)
112112
- [Organization Vulnerability Stats](<./trace/Organization Vulnerability Stats/README.md>)
113-
- [Security Controls](<./trace/Security Controls/README.md>)
114113
- [Trace Filters](<./trace/Trace Filters/README.md>)
115114
- [Trace Summary](<./trace/Trace Summary/README.md>)
116115
- [Vulnerability Notes](<./trace/Vulnerability Notes/README.md>)
116+
- [Security Controls](<./trace/Security Controls/README.md>)
117117
- USER
118118
- [Report Preferences](<./user/Report Preferences/README.md>)
119119
- [Users](<./user/Users/README.md>)
@@ -148,6 +148,7 @@
148148
- [IpDenylistDetailsRequest](<./objects/IpDenylistDetailsRequest.md>)
149149
- [IpDenylistDetailsResponse](<./objects/IpDenylistDetailsResponse.md>)
150150
- [MetadataFieldResource](<./objects/MetadataFieldResource.md>)
151+
- [MetadataFilter](<./objects/MetadataFilter.md>)
151152
- [NgQuickFilterResponse](<./objects/NgQuickFilterResponse.md>)
152153
- [RatingFacet](<./objects/RatingFacet.md>)
153154
- [RatingResult](<./objects/RatingResult.md>)
@@ -418,7 +419,6 @@
418419
- METADATA RESOURCE
419420
- [MetadataDTO](<./objects/MetadataDTO.md>)
420421
- [MetadataFieldBreakdownDTO](<./objects/MetadataFieldBreakdownDTO.md>)
421-
- [MetadataFilter](<./objects/MetadataFilter.md>)
422422
- [MetadataFilterGroup](<./objects/MetadataFilterGroup.md>)
423423
- [MetadataFilterSubfieldValue](<./objects/MetadataFilterSubfieldValue.md>)
424424
- [MetadataFilterValue](<./objects/MetadataFilterValue.md>)
@@ -447,6 +447,7 @@
447447
- [NotificationUserTriggerRequest](<./objects/NotificationUserTriggerRequest.md>)
448448
- NOTIFICATION RESOURCE
449449
- [AlertConditionResource](<./objects/AlertConditionResource.md>)
450+
- [AlertResource](<./objects/AlertResource.md>)
450451
- [NotificationOrganizationSettingsResource](<./objects/NotificationOrganizationSettingsResource.md>)
451452
- [NotificationOrganizationTriggerChannelResource](<./objects/NotificationOrganizationTriggerChannelResource.md>)
452453
- [NotificationOrganizationTriggerResource](<./objects/NotificationOrganizationTriggerResource.md>)
@@ -544,7 +545,6 @@
544545
- [AlertAttackTriggerIntervalResource](<./objects/AlertAttackTriggerIntervalResource.md>)
545546
- [AlertAttackTriggerResource](<./objects/AlertAttackTriggerResource.md>)
546547
- [AlertAttackTriggerStatusResource](<./objects/AlertAttackTriggerStatusResource.md>)
547-
- [AlertResource](<./objects/AlertResource.md>)
548548
- [ApplicationAttackResource](<./objects/ApplicationAttackResource.md>)
549549
- [AssessmentLicenseBreakdownResource](<./objects/AssessmentLicenseBreakdownResource.md>)
550550
- [AttackApplicationResource](<./objects/AttackApplicationResource.md>)

‎saas-restapi-v3/objects/AccessGroupResource.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,16 @@ EAC Group Resource
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| users | List of Users | list | | false |
8+
| access_level | Access level | accesscontrolgrouplevel | | false |
9+
| accounts | List of account roles | list | | false |
10+
| applications | List of all application that have access in this group | list | | false |
11+
| group_id | Group ID | long | | false |
12+
| is_onboarded_to_group | Whether Application access is onboarded to group | boolean | | false |
13+
| name | Group Name | string | | false |
14+
| readonly | Is group read-only | boolean | | false |
15+
| role | Role for all the applications | string | | false |
16+
| total_users | Number of users in this group | long | | false |
917
### Template
1018
```
11-
{"links":[],"users":[]}
19+
{"access_level":"","accounts":[],"applications":[],"group_id":0,"is_onboarded_to_group":true,"links":[],"name":"","readonly":true,"role":"","total_users":0}
1220
```

‎saas-restapi-v3/objects/AlertResource.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,20 @@ Alert Resource
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| alert_id | Alert ID | string | | false |
9-
| allAppsEnabled | Enable all applications | boolean | | false |
8+
| alert_id | Alert id | string | | false |
109
| allUsers | Enable for all users | boolean | | false |
11-
| apps | List of applications | list | | false |
10+
| apps | List of Application Alert Resources | list | | false |
1211
| conditions | List of conditions | list | | false |
1312
| description | Description | string | | false |
1413
| enabled | Enabled | boolean | | false |
1514
| frequency | Frequency | string | | false |
1615
| last_send_time | Last send time | long | | false |
17-
| name | Alert Name | string | | false |
16+
| name | Notification Name | string | | false |
1817
| recipients | List of recipients | list | | false |
1918
| tags | List of application tags | collection | | false |
20-
| triggers | List of triggers | list | | false |
2119
| type | Alert type | alerttype | | false |
2220
| users | List of TeamServer users recipients | list | | false |
2321
### Template
2422
```
25-
{"frequency":"","alert_id":"","allAppsEnabled":true,"allUsers":true,"apps":[],"conditions":[],"description":"","enabled":true,"last_send_time":0,"links":[],"name":"","recipients":[],"tags":[],"triggers":[],"type":"","users":[]}
23+
{"frequency":"","alert_id":"","allUsers":true,"apps":[],"conditions":[],"description":"","enabled":true,"last_send_time":0,"links":[],"name":"","recipients":[],"tags":[],"type":"","users":[]}
2624
```

‎saas-restapi-v3/objects/AttackMonitorFilterResponse.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
## AttackMonitorFilterResponse
22
---
33
### Description
4-
RASP Attacker Monitor Filter Response
4+
RASP Attacker Monitor Timeline Response
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| applications | Application Names | list | | false |
9-
| attackers | List of attackers | collection | | false |
108
| errors | List of errors | list | | false |
119
| messages | List of messages | list | | false |
12-
| rule | Rule Names | list | | false |
13-
| rule_severities | Rule Severities | list | | false |
1410
| success | Indicates whether API response was successful or not | boolean | | false |
11+
| total_events | Total number of events | int | | false |
12+
| total_requests | Total number of requests | int | | false |
13+
| trend_data | Trend Data | list | | false |
1514
### Template
1615
```
17-
{"applications":[],"attackers":[],"errors":[],"messages":[],"rule_severities":[],"rule":[],"success":true}
16+
{"errors":[],"messages":[],"success":true,"total_events":0,"total_requests":0,"trend_data":[]}
1817
```

‎saas-restapi-v3/objects/BaseApiFormResponse.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Base API form Response
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| impersonationEnabled | the value of impersonationEnabled property | boolean | | false |
98
| success | Indicates whether API response was successful or not | boolean | | false |
109
| messages | List of messages | list | | false |
1110
### Template
1211
```
13-
{"impersonationEnabled":true,"messages":[],"success":true}
12+
{"messages":[],"success":true}
1413
```

‎saas-restapi-v3/objects/BaseApiResponse.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Base API Response
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| errors | List of errors | list | | false |
98
| messages | List of messages | list | | false |
109
| success | Indicates whether API response was successful or not | boolean | | false |
1110
### Template
1211
```
13-
{"errors":[],"messages":[],"success":true}
12+
{"messages":[],"success":true}
1413
```

‎saas-restapi-v3/objects/EventResource.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,33 @@ Event Resource
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| eventName | Event name | string | | false |
9-
| status | Event status | attackstatus | | false |
10-
| time | Event timestamp | long | | false |
8+
| application | Application Resource | ApplicationAttackInfoResource | | false |
9+
| attack_suppressed | Is attack suppressed? | boolean | | false |
10+
| attack_type | Type of attack | attacktype | | false |
11+
| attack_uuid | Attack UUID | string | | false |
12+
| attackers | List of attackers | list | | false |
13+
| callLocation | Call Location | string | | false |
14+
| details | Details | string | | false |
15+
| detectionType | Detection type | string | | false |
16+
| displayName | Display name | string | | false |
17+
| event_uuid | Event UUID | string | | false |
18+
| exclusion_created | Has this event an exclusion created | boolean | | false |
19+
| httpRequest | HTTP Request | attacksamplerequestview | | false |
20+
| received | Received | long | | false |
21+
| result | Activity rule type | attackstatus | | false |
22+
| rule | Rule name | string | | false |
23+
| rule_id | Rule Id | long | | false |
24+
| rule_uuid | Rule UUID is a string that uniquely identifies the RASP rule associated with this attack event | string | | false |
25+
| server | Server | ServerResource | | false |
26+
| source | Source IP | string | | false |
27+
| sourceName | Source Name details | SourceNameResource | | false |
28+
| source_name | Source Name | string | | false |
29+
| suppressed | Suppressed | boolean | | false |
30+
| tags | Tags | set | | false |
31+
| type | Type of attack event (rule, IP blacklist, etc.) | string | | false |
32+
| url | URL. Empty if this RASP did not occur in the context of an HTTP request | string | | false |
33+
| user_input | User input values | EventUserInputResource | | false |
1134
### Template
1235
```
13-
{"eventName":"","links":[],"status":"","time":0}
36+
{"application":{"context_path":"","app_id":"","language":"","app_license":{},"name":"","attack_status":"","child":true,"first_seen":0,"importance":0,"importance_description":"","last_seen":0,"license_level":"","links":[],"master":true,"metadataEntities":[],"organization":{"api_only":true,"date_format":"","impersonation_enabled":true,"links":[],"name":"","protection_enabled":true,"time_format":"","timezone":"","user_access":true,"organization_uuid":""},"parent_app_id":"","primary":true,"roles":[],"servers":[],"status":"","total_modules":0},"attack_suppressed":true,"attack_type":"","attack_uuid":"","attackers":[],"callLocation":"","details":"","detectionType":"","displayName":"","event_uuid":"","exclusion_created":true,"httpRequest":{},"links":[],"received":0,"result":"","rule":"","rule_id":0,"rule_uuid":"","server":{"num_apps":0,"applications":[],"assess":true,"assess_enable_location":"","assess_enable_property_name":"","assess_last_update":0,"assessPending":true,"assess_sensors":true,"is_assess_status_locked":true,"config_source_assess":"","config_source_protect":"","defend":true,"defendPending":true,"defend_sensors":true,"defense_last_update":0,"diagnostic_collection_enabled":true,"agent_version":"","environment":"","first_activity":0,"has_instrumentation_conflict":true,"hostname":"","language":"","last_activity":0,"last_startup":0,"latest_agent_version":"","license":{"end":0,"licensed":true,"links":[],"start":0},"links":[],"logEnhancerPending":true,"logLevel":"","logPath":"","name":"","noPending":true,"out_of_date":true,"protect_enable_location":"","protect_enable_property_name":"","is_protect_status_locked":true,"sampling_profile":"","server_id":0,"path":"","type":"","status":"","syslog_enabled":true,"syslog_ip_address":"","tags":[]},"source":"","source_name":"","sourceName":{},"suppressed":true,"tags":[],"type":"","url":"","user_input":{"links":[],"name":"","omitted_value":true,"truncated_value":true,"type":"","value":""}}
1437
```

‎saas-restapi-v3/objects/MetadataFieldBreakdownDTO.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## MetadataFieldBreakdownDTO
22
---
33
### Description
4-
Metadata Field representation
4+
Metadata Breakdown Field representation
55
### Template
66
```
7-
{"agentLabel":"","displayLabel":"","fieldId":0,"fieldType":"","links":[],"required":true,"subfields":[],"unique":true}
7+
{"agentLabel":"","count":0,"displayLabel":"","fieldId":0,"fieldType":"","links":[],"required":true,"subfields":[],"unique":true}
88
```

‎saas-restapi-v3/objects/MetadataFilter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Metadata filter
55
### Fields
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
8-
| fieldID | Metadata Field ID | long | | false |
9-
| values | Values to filter on | array | | false |
8+
| values | Values to filter on | list | | true |
9+
| fieldID | Metadata Field ID | long | | true |
1010
### Template
1111
```
1212
{"fieldID":0,"values":[]}

‎saas-restapi-v3/objects/ProtectionRuleResource.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,23 @@ Protection Rule Resource
66
| Name | Description | Type | Allowed Values | Required |
77
| ---- | ----------- | ---- | -------------- | -------- |
88
| can_block | Rule can be blocked | boolean | | false |
9-
| can_block_at_perimeter | Can Block at Perimeter | boolean | | false |
10-
| category | Category | string | | false |
11-
| cve_shield | CVE shield | boolean | | false |
9+
| can_block_at_perimeter | Rule can block at perimeter | boolean | | false |
1210
| cves | CVEs | list | | false |
1311
| description | Description | string | | false |
14-
| displayName | Display name | string | | false |
15-
| id | Rule ID | long | | false |
16-
| impact | Attack impact | attackimpact | | false |
17-
| is_monitor_at_perimeter | Can Monitor at Perimeter | boolean | | false |
18-
| name | Name | string | | false |
19-
| uuid | UUID | string | | false |
12+
| development | Rule Configuration for development servers | blockingmode | | false |
13+
| enabled_dev | Rule Enabled for development servers | boolean | | false |
14+
| enabled_prod | Rule Enabled for production servers | boolean | | false |
15+
| enabled_qa | Rule Enabled for qa servers | boolean | | false |
16+
| id | Rule Type ID | long | | false |
17+
| is_monitor_at_perimeter | Rule is monitor at perimeter | boolean | | false |
18+
| name | Rule Name | string | | false |
19+
| parent_rule_name | Parent rule name | string | | false |
20+
| parent_rule_uuid | Parent rule unique id | string | | false |
21+
| production | Rule Configuration for production servers | blockingmode | | false |
22+
| qa | Rule Configuration for qa servers | blockingmode | | false |
23+
| type | Rule Type | string | | false |
24+
| uuid | Rule UUID | string | | false |
2025
### Template
2126
```
22-
{"can_block":true,"can_block_at_perimeter":true,"category":"","cve_shield":true,"cves":[],"description":"","displayName":"","impact":"","is_monitor_at_perimeter":true,"links":[],"name":"","id":0,"uuid":""}
27+
{"can_block":true,"can_block_at_perimeter":true,"cves":[],"description":"","development":"","enabled_dev":true,"enabled_prod":true,"enabled_qa":true,"is_monitor_at_perimeter":true,"links":[],"name":"","parent_rule_name":"","parent_rule_uuid":"","production":"","qa":"","id":0,"type":"","uuid":""}
2328
```

0 commit comments

Comments
 (0)