Find the agent keys

Important

If you download the YAML configuration file from Contrast (select Add agent in the top right) the file is pre-populated with your agent keys.

If you create your own YAML file, you'll need to add the keys yourself.

Agent keys are common to all agents in an organization. They are values that represent and identify the agents:

  • Agent username

  • Agent service key

The organization keys are values that represent the organization. They are sent by the agent (and API users) to identify which organization is being accessed.

  • API key

  • Contrast URL

  • Organization ID

All of these keys (except Organization ID) are required when installing agents.

Tip

The organization keys is also visible along with your personal keys under your profile.

To view the agent keys:

  1. Select User name > Organization settings in the top right corner.

  2. Select API to see the values for organization keys and agent keys.

    AgentKeys.png

    The Contrast URL is https://app.contrastsecurity.com/Contrast, or the URL of your on-premises or private cloud instance.

    Note

    If you don't see the agent username or service key on this page, it may mean that a license has not been applied to your organization. Contact Support for help with this.

  3. You can Rotate agent keys to generate new keys if your credentials have been compromised.

    Important

    Rotating agent service keys will take all agents offline. Your applications will still function, but data will not be sent to Contrast. To begin using the new credentials, reconfigure the agents and restart your applications. You can use a credential management system to coordinate this change among your systems.