Skip to content

Commit 58c3e96

Browse files
Auto-update SDK on 2026-09-28
1 parent 68772a9 commit 58c3e96

392 files changed

Lines changed: 44044 additions & 4102 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/FILES‎

Lines changed: 324 additions & 38 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 143 additions & 0 deletions
Large diffs are not rendered by default.

‎api/openapi.yaml‎

Lines changed: 6903 additions & 2880 deletions
Large diffs are not rendered by default.

‎docs/AccessEntityFilters.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ Name | Type | Description | Notes
99
**entity_types** | **List[str]** | Filter by entity type. Only RESOURCE, GROUP, and USER are queryable via OpalQuery. | [optional]
1010
**entity_item_types** | [**List[EntityItemTypeEnum]**](EntityItemTypeEnum.md) | Filter by entity item types. | [optional]
1111
**entity_name** | [**EntityNameFilter**](EntityNameFilter.md) | | [optional]
12+
**entity_description** | [**EntityDescriptionFilter**](EntityDescriptionFilter.md) | | [optional]
1213
**entity_tag** | [**EntityTagFilter**](EntityTagFilter.md) | | [optional]
14+
**hr_idp_status** | [**IdpStatusFilter**](IdpStatusFilter.md) | | [optional]
15+
**entity_admin_owner** | [**EntityAdminFilter**](EntityAdminFilter.md) | | [optional]
1316
**entity_ids** | **List[UUID]** | Filter by specific entity UUIDs. | [optional]
1417
**imported_from_app** | **List[UUID]** | Filter by app IDs from which returned nodes will be imported from. | [optional]
1518
**role_remote_ids** | **List[str]** | Filter by role remote IDs. Can only be applied within a hasAccessTo clause. | [optional]

‎docs/AppTypeEnum.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,20 @@ The type of an app.
2222

2323
* `CUSTOM` (value: `'CUSTOM'`)
2424

25+
* `CONFLUENCE` (value: `'CONFLUENCE'`)
26+
2527
* `CUSTOM_CONNECTOR` (value: `'CUSTOM_CONNECTOR'`)
2628

2729
* `DATABRICKS` (value: `'DATABRICKS'`)
2830

2931
* `DATASTAX_ASTRA` (value: `'DATASTAX_ASTRA'`)
3032

33+
* `ALICLOUD` (value: `'ALICLOUD'`)
34+
3135
* `DEVIN` (value: `'DEVIN'`)
3236

37+
* `DOCUSIGN` (value: `'DOCUSIGN'`)
38+
3339
* `DUO` (value: `'DUO'`)
3440

3541
* `GCP` (value: `'GCP'`)
@@ -50,8 +56,12 @@ The type of an app.
5056

5157
* `INCIDENTIO` (value: `'INCIDENTIO'`)
5258

59+
* `JIRA` (value: `'JIRA'`)
60+
5361
* `LDAP` (value: `'LDAP'`)
5462

63+
* `LINEAR` (value: `'LINEAR'`)
64+
5565
* `MARIADB` (value: `'MARIADB'`)
5666

5767
* `MONGO` (value: `'MONGO'`)
@@ -86,6 +96,8 @@ The type of an app.
8696

8797
* `SLACK` (value: `'SLACK'`)
8898

99+
* `TABLEAU` (value: `'TABLEAU'`)
100+
89101
* `TAILSCALE` (value: `'TAILSCALE'`)
90102

91103
* `TELEPORT` (value: `'TELEPORT'`)
@@ -98,6 +110,16 @@ The type of an app.
98110

99111
* `ZENDESK` (value: `'ZENDESK'`)
100112

113+
* `ZOOM` (value: `'ZOOM'`)
114+
115+
* `RAMP` (value: `'RAMP'`)
116+
117+
* `WRIKE` (value: `'WRIKE'`)
118+
119+
* `VERCEL` (value: `'VERCEL'`)
120+
121+
* `AXIOM` (value: `'AXIOM'`)
122+
101123
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
102124

103125

‎docs/Campaign.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Campaign
2+
3+
An access review campaign.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**campaign_id** | **UUID** | The ID of the campaign. |
10+
**name** | **str** | The name of the campaign. |
11+
**status** | [**CampaignStatusEnum**](CampaignStatusEnum.md) | |
12+
**is_template** | **bool** | Whether this campaign is a recurring schedule template. Templates spawn draft campaigns on schedule rather than being reviewed directly. |
13+
**created_at** | **datetime** | The creation time of the campaign. |
14+
**updated_at** | **datetime** | The last updated time of the campaign. |
15+
**created_by_user_id** | **UUID** | The ID of the user who created the campaign. |
16+
**configuration** | [**CampaignConfiguration**](CampaignConfiguration.md) | The campaign's configuration, if set. | [optional]
17+
**started_at** | **datetime** | The time the campaign was started, if started. | [optional]
18+
**started_by_user_id** | **UUID** | The ID of the user who started the campaign, if started. | [optional]
19+
**stopped_at** | **datetime** | The time the campaign was manually stopped, if stopped. | [optional]
20+
**stopped_by_user_id** | **UUID** | The ID of the user who stopped the campaign, if stopped. | [optional]
21+
**ended_at** | **datetime** | The time the campaign reached its scheduled end, if ended. | [optional]
22+
**ended_by_user_id** | **UUID** | The ID of the user who ended the campaign, if ended. | [optional]
23+
24+
## Example
25+
26+
```python
27+
from opal_security.models.campaign import Campaign
28+
29+
# TODO update the JSON string below
30+
json = "{}"
31+
# create an instance of Campaign from a JSON string
32+
campaign_instance = Campaign.from_json(json)
33+
# print the JSON string representation of the object
34+
print(Campaign.to_json())
35+
36+
# convert the object into a dict
37+
campaign_dict = campaign_instance.to_dict()
38+
# create an instance of Campaign from a dict
39+
campaign_from_dict = Campaign.from_dict(campaign_dict)
40+
```
41+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
42+
43+

‎docs/CampaignConfiguration.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# CampaignConfiguration
2+
3+
Configuration for an access review campaign.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**configuration_id** | **UUID** | The ID of the campaign configuration. |
10+
**created_at** | **datetime** | The creation time of the configuration. |
11+
**updated_at** | **datetime** | The last updated time of the configuration. |
12+
**query** | [**OpalAccessPathQueryBody**](OpalAccessPathQueryBody.md) | Access-path query defining the scope of access to review. Uses the same principalFilter / entitlementFilter shape as ACCESS OpalQuery. | [optional]
13+
**reviewer_assignment_policy** | [**UARReviewerAssignmentPolicyEnum**](UARReviewerAssignmentPolicyEnum.md) | |
14+
**allow_self_review** | **bool** | Whether reviewers can review their own access. |
15+
**send_reviewer_assignment_notification** | **bool** | Whether to notify reviewers upon assignment. |
16+
**allow_reviewer_reassignment** | **bool** | Whether reviewers may reassign their reviews to another user. |
17+
**start_date** | **datetime** | Scheduled start date of the campaign. | [optional]
18+
**end_date** | **datetime** | Scheduled end date of the campaign. | [optional]
19+
**timezone** | **str** | IANA timezone used to interpret campaign deadlines (e.g. America/Los_Angeles). |
20+
**revoke_on** | [**CampaignRevokeOnEnum**](CampaignRevokeOnEnum.md) | |
21+
**reminder_schedule** | **List[int]** | Days before end date to send reminder notifications. | [optional]
22+
**reminder_include_manager** | **bool** | Whether to include the reviewer's manager in reminders. |
23+
**require_reason_on_denial** | **bool** | Whether reviewers must provide a reason when denying (revoking) access. |
24+
**hide_ai_suggestions** | **bool** | Whether AI suggestions are hidden from reviewers. |
25+
**custom_start_message** | **str** | Optional custom message included when notifying reviewers that the campaign started. | [optional]
26+
**group_asset_visibility_policy** | [**CampaignGroupAssetVisibilityPolicyEnum**](CampaignGroupAssetVisibilityPolicyEnum.md) | |
27+
**is_template** | **bool** | Whether this configuration is a recurring schedule template. |
28+
**cron_expression** | **str** | Cron expression driving the recurring schedule. Null for one-off campaigns. | [optional]
29+
**next_scheduled_run** | **datetime** | Next time a draft will be generated from this template. | [optional]
30+
**last_scheduled_run** | **datetime** | Most recent time a draft was generated from this template. | [optional]
31+
**recurring_duration_days** | **int** | Deadline window in days applied to each draft generated from this template. | [optional]
32+
33+
## Example
34+
35+
```python
36+
from opal_security.models.campaign_configuration import CampaignConfiguration
37+
38+
# TODO update the JSON string below
39+
json = "{}"
40+
# create an instance of CampaignConfiguration from a JSON string
41+
campaign_configuration_instance = CampaignConfiguration.from_json(json)
42+
# print the JSON string representation of the object
43+
print(CampaignConfiguration.to_json())
44+
45+
# convert the object into a dict
46+
campaign_configuration_dict = campaign_configuration_instance.to_dict()
47+
# create an instance of CampaignConfiguration from a dict
48+
campaign_configuration_from_dict = CampaignConfiguration.from_dict(campaign_configuration_dict)
49+
```
50+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
51+
52+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CampaignGroupAssetVisibilityPolicyEnum
2+
3+
Controls what group assets reviewers can see during the campaign.
4+
5+
## Enum
6+
7+
* `STRICT` (value: `'STRICT'`)
8+
9+
* `VIEW_VISIBLE_AND_ASSIGNED` (value: `'VIEW_VISIBLE_AND_ASSIGNED'`)
10+
11+
* `VIEW_ALL` (value: `'VIEW_ALL'`)
12+
13+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
14+
15+

‎docs/CampaignItem.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# CampaignItem
2+
3+
A campaign review item — one direct access edge under review, matching a row on the admin Reviews tab.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**campaign_item_id** | **UUID** | The ID of the campaign item. |
10+
**campaign_id** | **UUID** | The ID of the parent campaign. |
11+
**target_type** | [**CampaignItemTargetTypeEnum**](CampaignItemTargetTypeEnum.md) | |
12+
**role_assignment_id** | **UUID** | The role assignment ID this item reviews (`target_id` when `target_type` is ROLE_ASSIGNMENT). |
13+
**status** | [**CampaignItemStatusEnum**](CampaignItemStatusEnum.md) | |
14+
**created_at** | **datetime** | When the item was created (snapshotted into the campaign). |
15+
**is_target_deleted** | **bool** | True when the underlying role assignment is soft-deleted. |
16+
**principal_id** | **UUID** | Principal ID from the role assignment. Null if the RA is missing. | [optional]
17+
**principal_type** | [**EntityTypeEnum**](EntityTypeEnum.md) | Principal entity type. Null if the RA is missing. | [optional]
18+
**entity_id** | **UUID** | Entitlement entity ID. Null if the RA is missing. | [optional]
19+
**entity_type** | [**EntityTypeEnum**](EntityTypeEnum.md) | Entitlement entity type. Null if the RA is missing. | [optional]
20+
**access_level** | [**ResourceAccessLevel**](ResourceAccessLevel.md) | Access level on the role assignment, if any. | [optional]
21+
**access_level_name** | **str** | Denormalized access level name stored on the campaign item. | [optional]
22+
**reviews** | [**List[CampaignItemReview]**](CampaignItemReview.md) | Reviewer assignments and decisions for this item. |
23+
**admin_override** | [**CampaignItemAdminOverride**](CampaignItemAdminOverride.md) | Admin override, if any. | [optional]
24+
25+
## Example
26+
27+
```python
28+
from opal_security.models.campaign_item import CampaignItem
29+
30+
# TODO update the JSON string below
31+
json = "{}"
32+
# create an instance of CampaignItem from a JSON string
33+
campaign_item_instance = CampaignItem.from_json(json)
34+
# print the JSON string representation of the object
35+
print(CampaignItem.to_json())
36+
37+
# convert the object into a dict
38+
campaign_item_dict = campaign_item_instance.to_dict()
39+
# create an instance of CampaignItem from a dict
40+
campaign_item_from_dict = CampaignItem.from_dict(campaign_item_dict)
41+
```
42+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
43+
44+

‎docs/CampaignItemAdminOverride.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# CampaignItemAdminOverride
2+
3+
Admin override applied to a campaign item. When set, it takes precedence over reviewer decisions for status and end-campaign remediations.
4+
5+
## Properties
6+
7+
Name | Type | Description | Notes
8+
------------ | ------------- | ------------- | -------------
9+
**actor_user_id** | **UUID** | The admin who applied the override. |
10+
**decision** | [**CampaignItemReviewDecisionEnum**](CampaignItemReviewDecisionEnum.md) | |
11+
**decided_at** | **datetime** | When the override was applied. |
12+
13+
## Example
14+
15+
```python
16+
from opal_security.models.campaign_item_admin_override import CampaignItemAdminOverride
17+
18+
# TODO update the JSON string below
19+
json = "{}"
20+
# create an instance of CampaignItemAdminOverride from a JSON string
21+
campaign_item_admin_override_instance = CampaignItemAdminOverride.from_json(json)
22+
# print the JSON string representation of the object
23+
print(CampaignItemAdminOverride.to_json())
24+
25+
# convert the object into a dict
26+
campaign_item_admin_override_dict = campaign_item_admin_override_instance.to_dict()
27+
# create an instance of CampaignItemAdminOverride from a dict
28+
campaign_item_admin_override_from_dict = CampaignItemAdminOverride.from_dict(campaign_item_admin_override_dict)
29+
```
30+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
31+
32+

0 commit comments

Comments
 (0)