1. Expel Support Center
  2. Getting started with Expel Workbench™
  3. About settings

Service accounts overview

  • Updated

In June 2023, Expel made API key management a self-service affair. The Service Accounts page is the home for you to create, disable, and delete keys used to power custom connections with Workbench through the Expel API. Full API documentation is located here. To use our Python client and to get ideas about how to use the Expel API, click here.

You can create multiple Service Accounts to organize your API keys in Workbench. Each service account can create multiple API keys. All API keys under a service account share the role and restrictions of the service account.

Two levels of access are available when creating a new API key:

  1. The Organization Admin has access to all API calls in Workbench.

  2. The Organization Analyst lets you do non-administrative tasks in Workbench, like marking investigative actions complete or sending remediation actions to another tool, but not adding context or users.

For each level, you can make the API key read-only.

Create a new service account

SaveServiceAccountKey.png

  1. In Workbench, go to Organization Settings > Service Accounts.

    ServiceAccountDashHead.png

  2. Give the service account a name, select its level of access, and whether or not it’s read only. Click Save.

    AddServiceAccount.png

  3. In the upper right, click Generate New API Key for the newly created service account.

    GenerateKeyHead.png

  4. Give the API key a name and click Next.

    GenerateServiceAccountKey.png

  5. Copy the API key.

    Caution

    You can't access this key again after you click Done. Make sure you copy the key and keep it in a secure location.

  6. Click Done.

Edit a service account

  1. In Workbench, go to the service account you want to edit. In the upper right, click the Generate API Key arrow and click Edit.

    EditMenuServiceAccount.png

  2. Do one or more of the following:

    EditServiceAccountDialogBox.png

    • Change the name.

    • Change the role.

      Note

      Changing the role for the service account changes the role for any associated API keys.

    • Change if it's read-only.

  3. Click Save when you're done.

Disable a service account

  1. In Workbench, go to the service account you want to disable. In the upper right, click the Generate API Key arrow and click Disable. All associated API keys are disabled.

    EditMenuServiceAccount.png

  2. You can re-enable the Service Account and its API keys at any time by clicking Enable.

Delete a service account

Caution

Deleting the Service Account also deletes any associated API keys. Make sure the API key isn’t being used by any critical services or processes. You CANNOT undo a service account deletion.

  1. In Workbench, go to the service account you want to edit. In the upper right, click the Generate API Key arrow and click Delete.

    EditMenuServiceAccount.png

  2. Click Delete.

Delete an API key

Caution

Make sure this API key isn’t being used by any critical services or processes. You CANNOT undo an API deletion.

  1. In Workbench , go to the service account with the API key you want to delete.

    DeleteServiceAccoutnAPI.png

  2. Next to the name of API key, click the trashcan.

  3. Click Delete.

  • Was this article helpful?

  • 0 out of 0 found this helpful

Related articles