Skip to main content

Configure agent keys

Agent keys let agents communicate with Contrast. Contrast supports the ability to configure multiple agent keys with different authentication credentials instead of sharing one key across an organization.

The benefits of having multiple agent keys include:

  • Enhanced security: Each team or service can manage its own credentials, reducing the risk of a single point of failure.

  • Operational flexibility: Teams can delete keys, add keys, or manage access without impacting other teams or services within the organization.

  • Granular control: By assigning specific agent keys to different contexts, organizations can better control and monitor agent access and activity.

Before you begin

  • To add or delete agent keys, you need these actions or roles:

    • If you are using role-based access control, you need a role with the Edit organization action.

    • If you are using organization users and groups, you need the Organization Admin role.

  • To view agent keys, you need these actions or roles:

    • If you are using role-based access control, you need a role with the Manage organization rules or Edit organization action.

    • If you are using organization users and groups, you need the Rules Admin or Edit role.

Add an agent key

  1. Under the user menu in the Contrast web interface, select Organization settings.

  2. Select Agent keys.

  3. Select Add key name.

  4. Enter a key name at the top of the list.

  5. Select Save key name.

    Contrast displays the keys for the new key name.

Image shows where to add the key name and then save the key name.

Delete an agent key

When you delete an agent key, any active agent using it will be unable to authenticate and will shut itself down.

  1. Under the user menu in the Contrast web interface, select Organization settings.

  2. Select Agent keys.

  3. Locate the agent key name you want to delete.

  4. Select the Delete icon (icon-delete.svg) at the end of the row.

  5. When prompted to do so, confirm you want to delete the key name by selecting Delete.