Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 171 additions & 38 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

77 changes: 77 additions & 0 deletions README.md

Large diffs are not rendered by default.

2,666 changes: 2,485 additions & 181 deletions api/openapi.yaml

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/AccessEntityFilters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Name | Type | Description | Notes
**entity_item_types** | [**List[EntityItemTypeEnum]**](EntityItemTypeEnum.md) | Filter by entity item types. | [optional]
**entity_name** | [**EntityNameFilter**](EntityNameFilter.md) | | [optional]
**entity_tag** | [**EntityTagFilter**](EntityTagFilter.md) | | [optional]
**hr_idp_status** | [**IdpStatusFilter**](IdpStatusFilter.md) | | [optional]
**entity_admin_owner** | [**EntityAdminFilter**](EntityAdminFilter.md) | | [optional]
**entity_ids** | **List[UUID]** | Filter by specific entity UUIDs. | [optional]
**imported_from_app** | **List[UUID]** | Filter by app IDs from which returned nodes will be imported from. | [optional]
**role_remote_ids** | **List[str]** | Filter by role remote IDs. Can only be applied within a hasAccessTo clause. | [optional]
Expand Down
12 changes: 12 additions & 0 deletions docs/AppTypeEnum.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,20 @@ The type of an app.

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

* `CONFLUENCE` (value: `'CONFLUENCE'`)

* `CUSTOM_CONNECTOR` (value: `'CUSTOM_CONNECTOR'`)

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

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

* `ALICLOUD` (value: `'ALICLOUD'`)

* `DEVIN` (value: `'DEVIN'`)

* `DOCUSIGN` (value: `'DOCUSIGN'`)

* `DUO` (value: `'DUO'`)

* `GCP` (value: `'GCP'`)
Expand All @@ -50,6 +56,8 @@ The type of an app.

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

* `JIRA` (value: `'JIRA'`)

* `LDAP` (value: `'LDAP'`)

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

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

* `TABLEAU` (value: `'TABLEAU'`)

* `TAILSCALE` (value: `'TAILSCALE'`)

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

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

* `ZOOM` (value: `'ZOOM'`)

[[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 changes: 43 additions & 0 deletions docs/Campaign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Campaign

An access review campaign.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_id** | **UUID** | The ID of the campaign. |
**name** | **str** | The name of the campaign. |
**status** | [**CampaignStatusEnum**](CampaignStatusEnum.md) | |
**is_template** | **bool** | Whether this campaign is a recurring schedule template. Templates spawn draft campaigns on schedule rather than being reviewed directly. |
**created_at** | **datetime** | The creation time of the campaign. |
**updated_at** | **datetime** | The last updated time of the campaign. |
**created_by_user_id** | **UUID** | The ID of the user who created the campaign. |
**configuration** | [**CampaignConfiguration**](CampaignConfiguration.md) | The campaign's configuration, if set. | [optional]
**started_at** | **datetime** | The time the campaign was started, if started. | [optional]
**started_by_user_id** | **UUID** | The ID of the user who started the campaign, if started. | [optional]
**stopped_at** | **datetime** | The time the campaign was manually stopped, if stopped. | [optional]
**stopped_by_user_id** | **UUID** | The ID of the user who stopped the campaign, if stopped. | [optional]
**ended_at** | **datetime** | The time the campaign reached its scheduled end, if ended. | [optional]
**ended_by_user_id** | **UUID** | The ID of the user who ended the campaign, if ended. | [optional]

## Example

```python
from opal_security.models.campaign import Campaign

# TODO update the JSON string below
json = "{}"
# create an instance of Campaign from a JSON string
campaign_instance = Campaign.from_json(json)
# print the JSON string representation of the object
print(Campaign.to_json())

# convert the object into a dict
campaign_dict = campaign_instance.to_dict()
# create an instance of Campaign from a dict
campaign_from_dict = Campaign.from_dict(campaign_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


52 changes: 52 additions & 0 deletions docs/CampaignConfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# CampaignConfiguration

Configuration for an access review campaign.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**configuration_id** | **UUID** | The ID of the campaign configuration. |
**created_at** | **datetime** | The creation time of the configuration. |
**updated_at** | **datetime** | The last updated time of the configuration. |
**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]
**reviewer_assignment_policy** | [**UARReviewerAssignmentPolicyEnum**](UARReviewerAssignmentPolicyEnum.md) | |
**allow_self_review** | **bool** | Whether reviewers can review their own access. |
**send_reviewer_assignment_notification** | **bool** | Whether to notify reviewers upon assignment. |
**allow_reviewer_reassignment** | **bool** | Whether reviewers may reassign their reviews to another user. |
**start_date** | **datetime** | Scheduled start date of the campaign. | [optional]
**end_date** | **datetime** | Scheduled end date of the campaign. | [optional]
**timezone** | **str** | IANA timezone used to interpret campaign deadlines (e.g. America/Los_Angeles). |
**revoke_on** | [**CampaignRevokeOnEnum**](CampaignRevokeOnEnum.md) | |
**reminder_schedule** | **List[int]** | Days before end date to send reminder notifications. | [optional]
**reminder_include_manager** | **bool** | Whether to include the reviewer's manager in reminders. |
**require_reason_on_denial** | **bool** | Whether reviewers must provide a reason when denying (revoking) access. |
**hide_ai_suggestions** | **bool** | Whether AI suggestions are hidden from reviewers. |
**custom_start_message** | **str** | Optional custom message included when notifying reviewers that the campaign started. | [optional]
**group_asset_visibility_policy** | [**CampaignGroupAssetVisibilityPolicyEnum**](CampaignGroupAssetVisibilityPolicyEnum.md) | |
**is_template** | **bool** | Whether this configuration is a recurring schedule template. |
**cron_expression** | **str** | Cron expression driving the recurring schedule. Null for one-off campaigns. | [optional]
**next_scheduled_run** | **datetime** | Next time a draft will be generated from this template. | [optional]
**last_scheduled_run** | **datetime** | Most recent time a draft was generated from this template. | [optional]
**recurring_duration_days** | **int** | Deadline window in days applied to each draft generated from this template. | [optional]

## Example

```python
from opal_security.models.campaign_configuration import CampaignConfiguration

# TODO update the JSON string below
json = "{}"
# create an instance of CampaignConfiguration from a JSON string
campaign_configuration_instance = CampaignConfiguration.from_json(json)
# print the JSON string representation of the object
print(CampaignConfiguration.to_json())

# convert the object into a dict
campaign_configuration_dict = campaign_configuration_instance.to_dict()
# create an instance of CampaignConfiguration from a dict
campaign_configuration_from_dict = CampaignConfiguration.from_dict(campaign_configuration_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/CampaignGroupAssetVisibilityPolicyEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CampaignGroupAssetVisibilityPolicyEnum

Controls what group assets reviewers can see during the campaign.

## Enum

* `STRICT` (value: `'STRICT'`)

* `VIEW_VISIBLE_AND_ASSIGNED` (value: `'VIEW_VISIBLE_AND_ASSIGNED'`)

* `VIEW_ALL` (value: `'VIEW_ALL'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


15 changes: 15 additions & 0 deletions docs/CampaignRevokeOnEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# CampaignRevokeOnEnum

When access decisions take effect during a campaign.

## Enum

* `ACTION` (value: `'ACTION'`)

* `END` (value: `'END'`)

* `NONE` (value: `'NONE'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


19 changes: 19 additions & 0 deletions docs/CampaignStatusEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CampaignStatusEnum

The current status of a campaign.

## Enum

* `DRAFT` (value: `'DRAFT'`)

* `ONGOING` (value: `'ONGOING'`)

* `COMPLETED` (value: `'COMPLETED'`)

* `STOPPED` (value: `'STOPPED'`)

* `ENDED` (value: `'ENDED'`)

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading