API keys enable you to power custom connections with Workbench through Workbench API. To organize your API keys, use service accounts.
Note
Each service account can contain multiple API keys. The role and restrictions of a service account apply to all API keys assigned to this account.
Note
To manage service accounts and API keys, you need administrator permissions.
To learn how to use the Expel API, see the Workbench API documentation.
Managing service accounts
In this section, you can learn how to do the following:
Create a service account
-
In Workbench, click Organization Settings > Service Accounts.
-
In the upper right corner, click Add Service Account.
-
In the Add Service Account dialog box, do the following:
-
In Service account name, type the name of your new service account.
-
From Workbench service account role, select a role.
-
Organization Admin can access all the API calls in Workbench.
-
Organization Analyst can perform tasks like marking investigative actions as complete, but can’t perform administrative tasks, like adding users.
Note
For each role, you can make the API key read-only.
-
-
To create a read-only service account, click the Read-only Access checkbox.
-
-
Click Save.
You can now create API keys under your new service account.
Edit a service account
-
In Workbench, click Organization Settings > Service Accounts.
-
Find the service account you want to edit.
-
To the right of Generate API Key, click the arrow and click Edit.
-
In the Edit Service Account dialog box, do any of the following:
-
In Service account name, change the name of the service account.
-
From Workbench service account role, select a role.
-
Organization Admin can access all the API calls in Workbench.
-
Organization Analyst can perform tasks like marking investigative actions as complete, but can’t perform administrative tasks, like adding users.
Note
When you change the role of a service account, this role changes for all associated API keys.
-
-
Change the read-only settings.
-
-
Click Save.
Disable a service account
-
In Workbench, click Organization Settings > Service Accounts.
-
Find the service account you want to disable.
-
To the right of Generate API Key, click the arrow and click Disable.
The account and all associated API keys are disabled.
Enable a disabled service account
-
In Workbench, click Organization Settings > Service Accounts.
-
Find the service account you want to enable.
-
To the right of Generate API Key, click the arrow and click Enable.
The account and all associated API keys are enabled.
Delete a service account
Caution
You can’t restore a deleted service account.
Caution
Deleting a service account also deletes all associated API keys.
-
In Workbench, click Organization Settings > Service Accounts.
-
Find the service account you want to delete.
-
To the right of Generate API Key, click the arrow and click Delete.
The account and all associated API keys are deleted.
Managing API keys
With service accounts, you can access and manage API keys. In this section, you can learn how to do the following:
Create an API key
-
To the right of a service account, click Generate API Key.
-
In the API key name field, enter the name of your new API key, and click Next.
-
From the Generate API Key dialog box, copy the API key and save it in a safe location.
Caution
When you finish the process and click Done, you can’t access this API key again.
-
Click Done.
Delete an API key
Caution
You can’t restore a deleted API key.
Caution
Before deleting an API key, make sure it isn’t used by critical services or processes.