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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
641 changes: 603 additions & 38 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

263 changes: 263 additions & 0 deletions README.md

Large diffs are not rendered by default.

14,679 changes: 11,276 additions & 3,403 deletions api/openapi.yaml

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions docs/AccessEntityFilters.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,11 @@ Name | Type | Description | Notes
**entity_types** | **List[str]** | Filter by entity type. Only RESOURCE, GROUP, and USER are queryable via OpalQuery. | [optional]
**entity_item_types** | [**List[EntityItemTypeEnum]**](EntityItemTypeEnum.md) | Filter by entity item types. | [optional]
**entity_name** | [**EntityNameFilter**](EntityNameFilter.md) | | [optional]
**entity_description** | [**EntityDescriptionFilter**](EntityDescriptionFilter.md) | | [optional]
**entity_tag** | [**EntityTagFilter**](EntityTagFilter.md) | | [optional]
**entity_tag_key** | [**EntityTagKeyFilter**](EntityTagKeyFilter.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
1 change: 1 addition & 0 deletions docs/AccessRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**admin_owner_id** | **UUID** | The ID of the owner of the group. |
**status** | **str** | The status of the access rule. |
**rule_clauses** | [**RuleClauses**](RuleClauses.md) | |
**uses_opal_query** | **bool** | True when the access rule uses an Opal Query, which the API can't describe yet. Its `ruleClauses` are then empty; view the rule in Opal. | [optional]

## Example

Expand Down
35 changes: 35 additions & 0 deletions docs/AddRoleAssignmentInput.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# AddRoleAssignmentInput

A single role assignment to create in a batch add request.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entity_id** | **UUID** | The ID of the entity (resource or group) being accessed. |
**entity_type** | [**EntityTypeEnum**](EntityTypeEnum.md) | The type of the entity being accessed. Must be `RESOURCE` or `GROUP`. |
**principal_id** | **UUID** | The ID of the principal (user, group, or resource) being granted access. |
**principal_type** | [**EntityTypeEnum**](EntityTypeEnum.md) | The type of the principal being granted access. Must be `RESOURCE`, `GROUP`, or `USER`. |
**access_level_remote_id** | **str** | Remote ID of the access level to grant. Omit for entities that only have a single default access level. | [optional]
**duration_minutes** | **int** | Duration of the grant in minutes. Omit or send `0` for an indefinite grant. | [optional]

## Example

```python
from opal_security.models.add_role_assignment_input import AddRoleAssignmentInput

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

# convert the object into a dict
add_role_assignment_input_dict = add_role_assignment_input_instance.to_dict()
# create an instance of AddRoleAssignmentInput from a dict
add_role_assignment_input_from_dict = AddRoleAssignmentInput.from_dict(add_role_assignment_input_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)


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

A single entry in the result of `POST /role-assignments`.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role_assignment** | [**RoleAssignment**](RoleAssignment.md) | |

## Example

```python
from opal_security.models.add_role_assignments_entry import AddRoleAssignmentsEntry

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

# convert the object into a dict
add_role_assignments_entry_dict = add_role_assignments_entry_instance.to_dict()
# create an instance of AddRoleAssignmentsEntry from a dict
add_role_assignments_entry_from_dict = AddRoleAssignmentsEntry.from_dict(add_role_assignments_entry_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)


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

Request body for `POST /role-assignments`.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**role_assignments** | [**List[AddRoleAssignmentInput]**](AddRoleAssignmentInput.md) | The list of role assignments to add. |

## Example

```python
from opal_security.models.add_role_assignments_request import AddRoleAssignmentsRequest

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

# convert the object into a dict
add_role_assignments_request_dict = add_role_assignments_request_instance.to_dict()
# create an instance of AddRoleAssignmentsRequest from a dict
add_role_assignments_request_from_dict = AddRoleAssignmentsRequest.from_dict(add_role_assignments_request_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)


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

Response body for `POST /role-assignments`.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task_ids** | **List[str]** | Opaque IDs of push tasks enqueued to propagate the new assignments to end systems. Each ID is a base64-encoded, URL-safe string that mirrors the identifier returned by the GraphQL `addRoleAssignments` mutation. |
**entries** | [**List[AddRoleAssignmentsEntry]**](AddRoleAssignmentsEntry.md) | One entry per role assignment created, in request order. |

## Example

```python
from opal_security.models.add_role_assignments_response import AddRoleAssignmentsResponse

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

# convert the object into a dict
add_role_assignments_response_dict = add_role_assignments_response_instance.to_dict()
# create an instance of AddRoleAssignmentsResponse from a dict
add_role_assignments_response_from_dict = AddRoleAssignmentsResponse.from_dict(add_role_assignments_response_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)


Loading