search cancel

Rally - How to create an API key

book

Article ID: 10814

calendar_today

Updated On:

Products

CA Agile Central SaaS (Rally)

Issue/Introduction

Rally Application Manager provides a set of authentication features for API and app developers and users.



Environment

Release:
Component: ACSAAS

Resolution

Access Rally Application Manager

To access the Rally Application Manager, login with your Rally username and password at the following URL: https://rally1.rallydev.com/login.

There are three tabs at the top of the page—Authorized Applications, API Keys, and OAuth Clients.

API Keys

Previously, a LoginKey was needed to collect and display CA Agile Central data in other systems, such as Confluence. This method also required a seat license to provide a user and password combination.

Now the API Keys page allows you to create keys that can be used to access your subscription data without needing a username and password. However, any application using the API Key you generated will have access and be tracked as if you logged in with your username and password. API Keys do not require an additional Rally license because they are an extension of your own user license.

API Keys are strings that authenticate a user when accessing the Rally Web Services API. However, unlike a session token, the API Key does not expire. API Keys obey the permissions of the user that generated them—like using that user’s credentials. Keys are valid as long as the user desires, and can be deleted or reset at any time. API keys will not authenticate if the username or password has expired.

Subscription Administrators may view, delete, and reset all active keys in a subscription from the API Keys page.

Note: If API Keys are disabled at the subscription level, a user trying to set up a new API Key or edit an existing API Key will see this error message that states: API Keys are disabled. Please contact your Subscription Administrator to enable this functionality. 

If API Keys are disabled:

§  The only action available on the API Key page is the ability to delete an existing API Key.

§  Existing keys will not work and will return a 401 error message.

 

Create a new Key

1.     From the API Keys Tab on the Application manager page, Click the Create New API Key link.

2.     Enter a name or description for the key in the Description field.

3.     Select the read-only or full access option from the Grant section.

4.     Click Create.

 

Your key is created and you can edit or delete the key as needed.

  

 

Additional Information

keywords: API key, Auth, WSAPI, Web Services API, script, code, job, OAuth, automate

Attachments