Jama Connect User Guide

Set API credentials

You can generate API credentials to integrate applications and scripts through the Jama Connect REST API. We currently use OAuth 2.0 authentication to generate pairs of client IDs and secrets. This method is often preferred by users and IT security groups over more basic methods that directly take usernames and passwords.

API credentials like these are only used for safer authentication. User access and privileges set by your Jama Connect administrator are still enforced.

For full instructions on how to use API credentials after you generate them, see the developer notes on authentication.

  1. Select your name in the header to open the My Profile window.

  2. Select Set API Credentials at the top right of the window.

  3. Add a name (required) to help remember why you made these credentials and an optional short description that's easy to understand, like Test Automation Integration.

  4. Select Create API Credentials. Jama Connect generates a new Client ID and Secret pair for you to use.

    set_api_credentials_window.png
  5. Copy the Client ID and Secret right away.

    Important

    The Client Secret is displayed only once, right after you create it. Copy the ID and Secret into your application before you continue. If you fail to copy them now, you must create a new Client ID and Secret pair to use.

Note

You can make a maximum of 20 API credentials, so remove any you don't want. You can do this by selecting Set API credentials from the My profile window, then selecting X next to the credentials you don't need.