Configuring OAuth Consumer Information for JIRA

An OAuth 'consumer' is an application that accesses ('consumes') data from another application. If you would like to add JIRA as a consumer to another external application (service provider), you will need to provide JIRA's consumer information to that application. For example, if your users want to add JIRA gadgets to their iGoogle dashboards, they will need to provide the consumer information for JIRA to iGoogle. You can also configure some optional information that can help identify your JIRA instance to users.

Please see the information below for instructions on configuring OAuth consumer information for JIRA. Additional information is also available in our Gadgets and Dashboards documentation.

To view JIRA's consumer information,

1. Log in as a user with the 'JIRA System Administrators' global permission.
2. Bring up the administration page by clicking either the 'Administration' link on the top bar or the title of the Administration box on the dashboard.
3. In the left-hand panel, under the title 'System', click the 'OAuth' link. The 'OAuth Administration' page will be displayed, showing a list of configured OAuth Consumers (if any exist).
4. Click the 'Consumer Info' tab at the top of the page. The consumer information for your JIRA instance will display (see screenshot below). You can then enter this information into your service provider, as required.
   Screenshot: Consumer Information (click to view larger image)
   

To edit JIRA's consumer information,

1. View the consumer information for JIRA, as described above.
2. Click the Edit link. The 'Update OAuth Consumer Information' page will display (see screenshot below).
   Screenshot: Consumer Information (click to view larger image)
   
3. Update the fields as desired. Please note, you cannot edit the 'Consumer Key' or 'Public Key'. These are unique identifiers for your instance.
   • 'Name' — The name of your site. This is defaulted to the application name. We recommend that you update it to include information that will help users easily identify your site, e.g. 'JIRA at http://jira.mycompany.com'.
   • 'Description' — A short description of your site. Service providers may or may not show this to users.
   • 'Callback URL' — The default address that users will be directed to after approving or denying the OAuth request. This address will be used if the consumer application connecting to the service provider does not supply its own callback. Leave this field empty, if you are not sure what to enter.