Skip to main content
System StatusContact Support Agility Community

Authorizing External Application Access

This feature is available in all editions.


Applications that access the Agility API must be registered (or authorized) and given an authentication grant. This allows them to operate within Agility on your behalf with your existing Role and Project Memberships.

From the Applications page (on the Member Details page), you can select public or create personal applications along with a grant that authorizes external applications to interface with Agility.

What is the difference between a public application and a personal application?

A "public" application is an application that has been created by an administrator and that is available for use by anyone within the system.  A "personal" application is an application that an individual member has created for themselves. Note that this type of application can only be used by the member who created it. It is not available to other members. 


Accessing the Applications Page

To access the Applications page, click on the user icon (in the top right corner of any page), and then select Applications.


Viewing Authorized Applications

The applications that already have access to your Agility instance display in the My Personal Applications and the My Public Applications sections of the Applications page. There, you can see basic details about each application, download OAuth2 JSON files, or revoke application access altogether. You cannot, however, make any edits.

Generating Application Access Grants

  1. In the upper right corner of any page, click on the user icon, and then select Applications.

  2. In Step 1, select an application type:

    • Choose Public to use an application that has been setup by your Agility administrator for everyone to use.

    • Choose Personal to create an application for your personal use only.

  3. In Step 2,

    • If you selected Public, select an application from the drop-down list.

    • If you selected Personal, enter the application name.

  4. Click Add

  5. In the popup window, copy the generated token to your clipboard so you can later paste it into the application want to access Agility on your behalf.

  6. Click Copy to Clipboard.


The access token popup displays only once when creating a new application, and cannot be retrieved later. If you forget your access token or fail to copy and store it in a secure location, you need to revoke it and then recreate it again to get a new access token. Note that Agility Access Tokens should be treated just like passwords, and should be stored securely and not shared.

Revoking Application Access

Since each application is separately registered, you can revoke access at any time without interfering with other applications.

To remove an application's access to your Agility instance, click the Revoke button next the name. Note the following:

  • revoking a "Public" application does not remove it from your Agility instance, it only removes it from your account. Other members can still use the application.
  • revoking a "Personal" application removes the application from your account altogether.

If you want to grant access at later time, simply recreate the application following the instructions above.