Skip to content

Commit bcc6e60

Browse files
github-actions[bot]github-actions[bot]
committed
Auto-update SDK on 2026-08-31
1 parent 68772a9 commit bcc6e60

219 files changed

Lines changed: 22728 additions & 301 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: 171 additions & 38 deletions
Large diffs are not rendered by default.

‎README.md‎

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

‎api/openapi.yaml‎

Lines changed: 2485 additions & 181 deletions
Large diffs are not rendered by default.

‎docs/AccessEntityFilters.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Name | Type | Description | Notes
1010
**entity_item_types** | [**List[EntityItemTypeEnum]**](EntityItemTypeEnum.md) | Filter by entity item types. | [optional]
1111
**entity_name** | [**EntityNameFilter**](EntityNameFilter.md) | | [optional]
1212
**entity_tag** | [**EntityTagFilter**](EntityTagFilter.md) | | [optional]
13+
**hr_idp_status** | [**IdpStatusFilter**](IdpStatusFilter.md) | | [optional]
14+
**entity_admin_owner** | [**EntityAdminFilter**](EntityAdminFilter.md) | | [optional]
1315
**entity_ids** | **List[UUID]** | Filter by specific entity UUIDs. | [optional]
1416
**imported_from_app** | **List[UUID]** | Filter by app IDs from which returned nodes will be imported from. | [optional]
1517
**role_remote_ids** | **List[str]** | Filter by role remote IDs. Can only be applied within a hasAccessTo clause. | [optional]

‎docs/AppTypeEnum.md‎

Lines changed: 12 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,6 +56,8 @@ The type of an app.
5056

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

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

5563
* `MARIADB` (value: `'MARIADB'`)
@@ -86,6 +94,8 @@ The type of an app.
8694

8795
* `SLACK` (value: `'SLACK'`)
8896

97+
* `TABLEAU` (value: `'TABLEAU'`)
98+
8999
* `TAILSCALE` (value: `'TAILSCALE'`)
90100

91101
* `TELEPORT` (value: `'TELEPORT'`)
@@ -98,6 +108,8 @@ The type of an app.
98108

99109
* `ZENDESK` (value: `'ZENDESK'`)
100110

111+
* `ZOOM` (value: `'ZOOM'`)
112+
101113
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
102114

103115

‎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_PATH 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+

‎docs/CampaignGroupAssetVisibilityPolicyEnum.md‎

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/CampaignRevokeOnEnum.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CampaignRevokeOnEnum
2+
3+
When access decisions take effect during a campaign.
4+
5+
## Enum
6+
7+
* `ACTION` (value: `'ACTION'`)
8+
9+
* `END` (value: `'END'`)
10+
11+
* `NONE` (value: `'NONE'`)
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/CampaignStatusEnum.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# CampaignStatusEnum
2+
3+
The current status of a campaign.
4+
5+
## Enum
6+
7+
* `DRAFT` (value: `'DRAFT'`)
8+
9+
* `ONGOING` (value: `'ONGOING'`)
10+
11+
* `COMPLETED` (value: `'COMPLETED'`)
12+
13+
* `STOPPED` (value: `'STOPPED'`)
14+
15+
* `ENDED` (value: `'ENDED'`)
16+
17+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
18+
19+

0 commit comments

Comments
 (0)