Skip to content
Merged
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
4 changes: 4 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ docs/GroupRemoteInfoConnectorGroup.md
docs/GroupRemoteInfoDatabricksAccountGroup.md
docs/GroupRemoteInfoDevinGroup.md
docs/GroupRemoteInfoDuoGroup.md
docs/GroupRemoteInfoGithubEnterpriseTeam.md
docs/GroupRemoteInfoGithubTeam.md
docs/GroupRemoteInfoGitlabGroup.md
docs/GroupRemoteInfoGoogleGroup.md
Expand Down Expand Up @@ -210,6 +211,7 @@ docs/ResourceRemoteInfoGcpOrganization.md
docs/ResourceRemoteInfoGcpProject.md
docs/ResourceRemoteInfoGcpServiceAccount.md
docs/ResourceRemoteInfoGcpSqlInstance.md
docs/ResourceRemoteInfoGithubEnterpriseRole.md
docs/ResourceRemoteInfoGithubOrg.md
docs/ResourceRemoteInfoGithubOrgRole.md
docs/ResourceRemoteInfoGithubRepo.md
Expand Down Expand Up @@ -357,6 +359,7 @@ model_group_remote_info_connector_group.go
model_group_remote_info_databricks_account_group.go
model_group_remote_info_devin_group.go
model_group_remote_info_duo_group.go
model_group_remote_info_github_enterprise_team.go
model_group_remote_info_github_team.go
model_group_remote_info_gitlab_group.go
model_group_remote_info_google_group.go
Expand Down Expand Up @@ -468,6 +471,7 @@ model_resource_remote_info_gcp_organization.go
model_resource_remote_info_gcp_project.go
model_resource_remote_info_gcp_service_account.go
model_resource_remote_info_gcp_sql_instance.go
model_resource_remote_info_github_enterprise_role.go
model_resource_remote_info_github_org.go
model_resource_remote_info_github_org_role.go
model_resource_remote_info_github_repo.go
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Class | Method | HTTP request | Description
*DelegationsAPI* | [**GetDelegation**](docs/DelegationsAPI.md#getdelegation) | **Get** /delegations/{delegation_id} | Get delegation by ID
*DelegationsAPI* | [**GetDelegations**](docs/DelegationsAPI.md#getdelegations) | **Get** /delegations | Get delegations
*EventsAPI* | [**Events**](docs/EventsAPI.md#events) | **Get** /events |
*EventsAPI* | [**GetEvent**](docs/EventsAPI.md#getevent) | **Get** /events/{event_id} | Get event by ID
*GroupBindingsAPI* | [**CreateGroupBinding**](docs/GroupBindingsAPI.md#creategroupbinding) | **Post** /group-bindings |
*GroupBindingsAPI* | [**DeleteGroupBinding**](docs/GroupBindingsAPI.md#deletegroupbinding) | **Delete** /group-bindings/{group_binding_id} |
*GroupBindingsAPI* | [**GetGroupBinding**](docs/GroupBindingsAPI.md#getgroupbinding) | **Get** /group-bindings/{group_binding_id} | Get group binding by ID
Expand Down Expand Up @@ -283,6 +284,7 @@ Class | Method | HTTP request | Description
- [GroupRemoteInfoDatabricksAccountGroup](docs/GroupRemoteInfoDatabricksAccountGroup.md)
- [GroupRemoteInfoDevinGroup](docs/GroupRemoteInfoDevinGroup.md)
- [GroupRemoteInfoDuoGroup](docs/GroupRemoteInfoDuoGroup.md)
- [GroupRemoteInfoGithubEnterpriseTeam](docs/GroupRemoteInfoGithubEnterpriseTeam.md)
- [GroupRemoteInfoGithubTeam](docs/GroupRemoteInfoGithubTeam.md)
- [GroupRemoteInfoGitlabGroup](docs/GroupRemoteInfoGitlabGroup.md)
- [GroupRemoteInfoGoogleGroup](docs/GroupRemoteInfoGoogleGroup.md)
Expand Down Expand Up @@ -394,6 +396,7 @@ Class | Method | HTTP request | Description
- [ResourceRemoteInfoGcpProject](docs/ResourceRemoteInfoGcpProject.md)
- [ResourceRemoteInfoGcpServiceAccount](docs/ResourceRemoteInfoGcpServiceAccount.md)
- [ResourceRemoteInfoGcpSqlInstance](docs/ResourceRemoteInfoGcpSqlInstance.md)
- [ResourceRemoteInfoGithubEnterpriseRole](docs/ResourceRemoteInfoGithubEnterpriseRole.md)
- [ResourceRemoteInfoGithubOrg](docs/ResourceRemoteInfoGithubOrg.md)
- [ResourceRemoteInfoGithubOrgRole](docs/ResourceRemoteInfoGithubOrgRole.md)
- [ResourceRemoteInfoGithubRepo](docs/ResourceRemoteInfoGithubRepo.md)
Expand Down
64 changes: 62 additions & 2 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,35 @@ paths:
- BearerAuth: []
tags:
- events
/events/{event_id}:
get:
summary: Get event by ID
description: Returns an `Event` object.
operationId: getEvent
parameters:
- description: The ID of the event.
example: 29827fb8-f2dd-4e80-9576-28e31e9934ac
explode: true
in: path
name: event_id
required: true
schema:
format: uuid
type: string
style: simple
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/Event"
description: The requested `Event`.
"404":
description: Event not found.
security:
- BearerAuth: []
tags:
- events
/groups:
get:
summary: Get groups
Expand Down Expand Up @@ -1091,13 +1120,23 @@ paths:
format: uuid
type: string
style: simple
- description: The access level's remote ID to filter by.
example: arn:aws:iam::590304332660:role/AdministratorAccess
explode: true
in: query
name: access_level_remote_id
required: false
schema:
type: string
style: form

responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/GroupContainingGroupList"
description: The resources that the group gives access to.
description: The groups that the group gives access to.
security:
- BearerAuth: []
tags:
Expand Down Expand Up @@ -6029,7 +6068,6 @@ components:
- GIT_LAB
- GIT_LAB_CONNECTION
- TELEPORT
- SLACK
example: GIT_HUB
type: string
PaginatedGroupsList:
Expand Down Expand Up @@ -6647,6 +6685,7 @@ components:
- INCIDENTIO_ON_CALL_SCHEDULE
- ROOTLY_ON_CALL_SCHEDULE
- DEVIN_GROUP
- GIT_HUB_ENTERPRISE_TEAM
example: OPAL_GROUP
type: string
ResourceTypeEnum:
Expand Down Expand Up @@ -6726,6 +6765,7 @@ components:
- VAULT_SECRET
- VAULT_POLICY
- VAULT_OIDC_ROLE
- GIT_HUB_ENTERPRISE_ROLE
example: AWS_IAM_ROLE
type: string
VisibilityTypeEnum:
Expand Down Expand Up @@ -7245,6 +7285,16 @@ components:
type: object
required:
- team_slug
github_enterprise_team:
description: Remote info for GitHub Enterprise team.
properties:
team_slug:
description: The slug of the GitHub Enterprise team.
example: opal-security
type: string
type: object
required:
- team_slug
gitlab_group:
description: Remote info for Gitlab group.
properties:
Expand Down Expand Up @@ -7882,6 +7932,16 @@ components:
type: object
required:
- org_name
github_enterprise_role:
description: Remote info for GitHub Enterprise role.
properties:
role_id:
description: The id of the role.
example: 112233
type: string
type: object
required:
- role_id
gitlab_project:
description: Remote info for Gitlab project.
properties:
Expand Down
104 changes: 104 additions & 0 deletions api_events.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions api_groups.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

71 changes: 71 additions & 0 deletions docs/EventsAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All URIs are relative to *https://api.opal.dev/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Events**](EventsAPI.md#Events) | **Get** /events |
[**GetEvent**](EventsAPI.md#GetEvent) | **Get** /events/{event_id} | Get event by ID



Expand Down Expand Up @@ -87,3 +88,73 @@ Name | Type | Description | Notes
[[Back to Model list]](../README.md#documentation-for-models)
[[Back to README]](../README.md)


## GetEvent

> Event GetEvent(ctx, eventId).Execute()

Get event by ID



### Example

```go
package main

import (
"context"
"fmt"
"os"
openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
eventId := "29827fb8-f2dd-4e80-9576-28e31e9934ac" // string | The ID of the event.

configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.EventsAPI.GetEvent(context.Background(), eventId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `EventsAPI.GetEvent``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetEvent`: Event
fmt.Fprintf(os.Stdout, "Response from `EventsAPI.GetEvent`: %v\n", resp)
}
```

### Path Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
**eventId** | **string** | The ID of the event. |

### Other Parameters

Other parameters are passed through a pointer to a apiGetEventRequest struct via the builder pattern


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------


### Return type

[**Event**](Event.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

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

Loading