Prerequisites
- You must have admin permissions in Orca to perform the steps in this guide.
Quick Start
Step 1: Enable API Access
-
Log into the Orca Security dashboard and navigate to Settings > Users and Permissions > API.
-
Select Create API Token.
-
Generate a new token with the following parameters:
-
Name - enter "Expel Integration".
-
Never Expire - select this checkbox.
- Service Token - select this checkbox (to prevent the token expiring with a user account).
-
Role - Viewer.
-
Scope - All Accounts.
-
-
Select Create Token.
- Save the newly created token.
Step 2: Configure the Technology in Workbench
- Log in to Workbench.
- In the side menu, navigate to Organization Settings > Security Devices.
- Select Add Security Device.
- In the search box, type “Orca Security” and then select the Orca Security integration.
- Complete the fields as follows:
- Name - enter a name that might help you more easily identify this integration, such as “CompanyName Orca Security”; this name will display in Workbench under the Name column, and is a text string that you can filter on.
- Location - enter the location of your integration, for example “cloud;” this is also a text string that you can filter on, so we recommend being consistent with location naming across your Expel integrations.
-
Server address - enter
https://api.orcasecurity.io
. -
API token - enter the saved API token.
- Select Save.
-
Your device should be created successfully within a few seconds. A few reminders:
- After your connection is healthy, it will take some time for your device to begin polling and receiving data.
- To check on the status, select the downward arrow for your device in the first column and choose View details. You can then scroll to the Connection section to see if your device is fully connected.
- Polling will happen first; data will be received after that. You must refresh the page to see updates.
- If your device does not begin polling within 15 minutes, and does not begin receiving data within 30 minutes, contact our support team for help.