> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Orca Security

> How to set up the Orca Security connector, plus the actions that are available.

![Orca Security](https://stackone-logos.com/api/orcasecurity/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/orcasecurity/changelog.md)

[33 actions](#actions) · 1 auth method

Security
IAM
Security

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Token · Connector Profile](https://docs.stackone.com/connectors/orcasecurity/guides/connector-profile/api-token.md)
>
> Uses an Orca API token created in one region, so the token works only in that region. The token lasts until the expiry c...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Token · Link Account](https://docs.stackone.com/connectors/orcasecurity/guides/link-account/api-token.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

33 actions

ActionDescription

Get Group`orcasecurity_get_rbac_group`

Get a group of the Orca Security organization

List Group Role Assignments`orcasecurity_list_group_role_assignments`

List the role assignments of the groups in the Orca Security organization

List Unified Organizations`orcasecurity_unified_list_organizations`

List the Orca Security organization the connection belongs to.

Get Unified Organization`orcasecurity_unified_get_organization`

Get the unified Orca Security organization of the connection by ID.

List Unified Roles`orcasecurity_unified_list_roles`

List the roles of an Orca Security organization.

Get Unified Role`orcasecurity_unified_get_role`

Get a unified Orca Security role by ID.

List Unified Users`orcasecurity_unified_list_users`

List unified users in an Orca Security organization.

Get Unified User`orcasecurity_unified_get_user`

Get a unified Orca Security user by ID.

List User Invitations`orcasecurity_list_user_invites`

List the invitations to the Orca Security organization, including expired ones

Get Current Organization`orcasecurity_get_current_organization`

Get the Orca Security organization of the connection

List Roles`orcasecurity_list_rbac_roles`

List the roles of the Orca Security organization

Get Role`orcasecurity_get_rbac_role`

Get the detail of a custom role in the Orca Security organization

List User Role Assignments`orcasecurity_list_user_role_assignments`

List the role assignments of the users in the Orca Security organization

List Users`orcasecurity_list_users`

List the users of the Orca Security organization

List Alerts`orcasecurity_alerts_list`

List Orca security alerts, optionally filtered with a DSL expression and paged with a cursor.

Get Alert`orcasecurity_alerts_get`

Retrieve a single Orca alert by its unique identifier.

Update Alert Status`orcasecurity_alerts_update_status`

Set the status of one or more Orca alerts in bulk.

Snooze Alerts`orcasecurity_alerts_snooze`

Snooze one or more Orca alerts for a number of days.

Add Comment To Alert`orcasecurity_alerts_add_comment`

Attach a comment to one or more Orca alerts.

List Alert Event Log`orcasecurity_alerts_event_log`

Retrieve the event and change log for a specific Orca alert.

List Assets`orcasecurity_assets_list`

List Orca cloud assets, optionally filtered and paged with an offset.

Get Asset`orcasecurity_assets_get`

Retrieve a single Orca cloud asset by its unique identifier.

List Cloud Accounts`orcasecurity_cloud_accounts_list`

List the cloud accounts connected to Orca, with filtering, sorting and cursor pagination.

Get Cloud Account`orcasecurity_cloud_accounts_get`

Retrieve a single connected cloud account by its unique identifier.

Query Alerts`orcasecurity_query_alerts`

Query Orca security alerts using the Orca DSL, with optional filters and cursor pagination.

Query Assets`orcasecurity_query_assets`

Query Orca cloud assets using the Orca DSL, with optional filters and cursor pagination.

Query Inventory`orcasecurity_query_inventory`

Query Orca cloud inventory using the Orca DSL, optionally returning a downloadable result link.

Query CVEs`orcasecurity_query_cves`

Query Orca CVE and vulnerability records using the Orca DSL, with cursor pagination.

Query Logs`orcasecurity_query_logs`

Query Orca log records using the Orca DSL, with cursor pagination.

Query Catalog`orcasecurity_query_catalog`

Retrieve the catalog of predefined Orca queries available to the tenant.

Query Schema`orcasecurity_query_schema`

Retrieve the schema for an Orca query data type, or all available data-type schemas.

Create Scan`orcasecurity_scans_create`

Launch an on-demand Orca security scan for one or more assets.

Get Scan`orcasecurity_scans_get`

Retrieve the status and progress of a specific Orca scan by its identifier.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.