Rally API key creation and management

Products

• Rally SaaS

Issue/Introduction

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

Resolution

Access Rally Application Manager

To access the Rally Application Manager / API Keys page:

1. Log in with your Rally username and password at the following URL: https://rally1.rallydev.com/login.
2. There are three tabs at the top of the page:
   • Authorized Applications
   • API Keys
   • OAuth Clients

API Keys Information

• Please refer to this document for more details about the information below in this article
  • https://techdocs.broadcom.com/us/en/ca-enterprise-software/valueops/rally/rally-help/administration/it-administration/how-users-authenticate/rally-authentication-features/api-keys.html 
• The API Keys page
  • Allows you to create keys that can be used to access your subscription data without needing a username and password.
• 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.
  • Obey the permissions of the user that generated them—like using that user’s credentials. 
  • Are valid as long as the user desires, and can be deleted or reset at any time.
  • Will not authenticate if the username or password has expired.
  • Any application using the API Key you generated will have access and be tracked as if you logged in with your username and password.
  • Do not require an additional Rally license because they are an extension of your own user license.
• Subscription Administrators may view, delete, and reset all active keys in a subscription from the API Keys page.
• 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. Contact your Subscription Administrator to enable this functionality.
  • 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.

Additional Information

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