Generating API Keys

Use a Key ID and Key Secret to access the AppScan on Cloud REST APIs and to log in from some of the ASoC client tools (for example, from the Jenkins plug-in and from the Static Analyzer Command Line Utility and IDE plug-ins).

About this task

A Key ID is unique to each user. If you do not have a Key ID, or if you have lost your Key Secret, you can generate a new combination. To generate a new key, either:

Procedure

  1. Go to the API key page at the AppScan on Cloud service:
  2. Generate the key through the user interface:
    1. Click the user menu in the upper-right corner and select API key or Account settings > API key.
    2. Click Generate new keys.
    3. If you have already generated the keys, a warning appears indicating that creating a new key pair will break any existing integrations that rely on your current credentials. Click Proceed to continue.
    4. Optional: Set an expiration date (enabled by default) by selecting a date and clicking Proceed. If you do not want to set an expiration date, clear the checkbox and click Proceed.
    5. You are required to re-authenticate before a new key is issued. Complete the login prompt to continue. After successful authentication, the new Key ID and Key Secret are displayed.
      Attention:
      The Key Secret is shown only once and is visible for one minute. Copy and store it in a secure secrets manager. The secret cannot be viewed again through the UI. Generating a new key immediately expires the previous one.
      Note:
      Users with permission to revoke keys may delete their own key from this page using Revoke API keys
  3. Key management for administrators and managers:

    Administrators and Managers (roles that have the manage API keys permission) can view and manage API keys for other users from the User Management page. Administrators and Managers can revoke another user’s API key; however, revoking a key does not prevent that user from generating a new one if their role allows it.