Obtain client details for API access

Click Configuration on the top right of the page, and select Integrations from the navigation menu on the left.

Tab: Integrations > API. Visible to Site Administrators only.

Add an application that will integrate with Agile Manager. This creates client credentials that the application can use for OAuth authentication when connecting to Agile Manager.

You can add the following types of applications:

  • An application that will communicate with Agile Manager using the API.
    For details on using the Agile Manager API, see API integration.
  • A NextGen Synchronizer Integration Bridge.
    For details on the Integration Bridge, see Download and install the bridge.

A client is similar to an Agile Manager user that accesses Agile Manager through the API. The client is assigned to specific workspaces and roles, just like other Agile Manager users.

An Integration Bridge client has only the Integration Bridge role and can work with all workspaces.

The client ID is generated automatically when you register a new application.

A client secret is generated for each client. This secret is like a user password, and you must record it securely. Agile Manager generates each secret once only, and the secret cannot be retrieved later. If needed, regenerate the secret to retrieve a new one.

What do you want to do?

  1. Click Add New.
  2. In the Type drop down, select Application.

  3. Populate the fields in the dialog box, and click OK.

    The workspaces and roles assigned to the client determine the items accessible by the client and API. For more details, see User roles and permissions.

  4. From the Client Details dialog box, copy the secret to a secure location. You will not be able to access this secret from Agile Manager later on.

    The client ID displayed in this dialog box is also displayed in the grid on the Integrations > API tab.

Use the client ID and secret in your application for API authentication.

  1. Click Add New.
  2. In the Type drop down, select Integration Bridge.

  3. Enter a name and a description (optional) and click OK.

  4. From the Client Details dialog box, copy the secret to a secure location. You will not be able to access this secret from Agile Manager later on.

    The client ID displayed in this dialog box is also displayed in the grid on the Integrations > API tab.

Use the client ID and secret for the Agile Manager credentials of an Integration Bridge installation.

To modify a client's details, click the client ID link in the grid.

  • For an Application client, you can edit Name, Description, Workspaces, or Roles.
  • For an Integration Bridge client, you can edit the Name or Description.
  • You cannot modify the value of a client ID.
  1. Select the row for an existing client, and click Regenerate Secret.
  2. Confirm that you do want to regenerate the secret. Doing so renders your current secret inactive, and you will need to update your secret in all relevant locations.

  3. From the Client Details dialog box, copy the secret to a secure location for use in your API. You will not be able to access this secret from Agile Manager later on.

Remove an existing client if it is no longer in use.

Select the row for an existing application, and click Remove Credentials.

  1. Click API Interactive Help.
  2. In the top right corner of the Interactive Help page, enter your client ID and secret to access the API operations.

The Interactive Help is also available from the Help menu (Help > API Interactive Help).