Managing Consumers

A consumer is another web application that is allowed to send requests to this application on behalf of an authorized user. In other words, a consumer is a client application that consumes (or possibly generates/updates) the information of Jira (through this app) using an authorized Jira user.

Consumers are needed to create incoming Collaboration Links; this means you need to register the CLM Application as a consumer of Jira, if you want to create Collaboration Links on the CLM Application side; keep in mind that additional configuration will be required also there, but for now let's focus on the requirements of this side.

It is worth to mention that regular consumers are not bound to any particular Jira user, they have their own identity and, at the proper working moment, they will request Jira credentials to work on behalf of a user (a process known as "user authentication"). Let's call these regular consumers as consumers for humans, because a human is required to complete the user authentication process; however, the CLM Application may have automatic processes wanting to consume the Jira information; in such cases, it is more convenient to bound a specific Jira user to the consumer and avoid the need for a human. Let's call such consumers as consumers for applications and the bounded user as functional user. No matter the kind of consumer, all of them identify themselves with a Key, and in this sense, there are two types of consumers (depending on the type of its Key):

  1. Consumers with an Authorized Key 
  2. Consumers with a Provisional Key

Another way of categorizing consumers is whether they are trusted or not:

  1. Trusted consumers are not required to be authorized by the user after the user authentication process.
  2. Not trusted consumers need to be authorized by the user even after the user authentication process [1].

Next procedures focus on actions you can do in the consumers page, this means the registry and removing of consumers is about consumers with authorized key; it also means you won't find a procedure to register a consumer with a provisional key.

Registering a Consumer.

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Consumers option in the OSLC Connect section.
  3. Click on the Add Consumer button at the top of the right panel.
  4. Fill out the form on the Add Consumer dialog according to the following field descriptions:
    Field Required Description Notes Suggested Value
    Name Yes Logical name for human identification. Commonly the client application name. The CLM Application name.
    Key No Unique consumer identifier. System will generate one for you if not provided. Leave it empty
    Secret Yes Consumer password. Along with Key, required for consumer authentication. Whatever you want you don't forget.
    Confirmation Yes Password confirmation. Just a confirmation field to avoid password typos. The same as Secret field.
    Trusted Yes Whether a consumer will be trusted or not. Check to avoid extra user authorization on each session. checked
  5. Click on the Add button.

If everything went ok, a new consumer entry will be displayed on the Authorized keys section; note: the Secret field is hidden. If you decided to provide a custom Key field value, make sure there is not an existing consumer with the same key or you will get an error message from the system.

Removing a Consumer.

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Consumers option in the OSLC Connect section.
  3. Locate the Authorized keys section and table at the bottom of the center panel.
  4. Choose the consumer you want to remove and click on the corresponding trash icon located on the last column of the table.
  5. Confirm your decision by clicking on the OK button in the confirmation dialog.

If everything went ok, the chosen consumer will be removed from the system and it will no longer appear on the table.

Assigning a Functional User.

In the case the CLM Application requires a functional user for a consumer, what you need to do once the consumer is registered is:

  1. In the Authorized keys section, click on the Select user... link corresponding to the consumer you want to modify.
  2. In the opened Select User dialog, type the first words or the complete name of the user you are looking for in the Name field, this will cause the Matching users field be filled with matching user names.
  3. Select the appropriate match from the Matching users field and click the Select button.

If everything went ok, the chosen user name will be displayed in the row of the modified consumer instead of the Select user... link.

Removing a Functional User.

To remove the functional user of a consumer you need to:

  1. In the Authorized keys section, pass the mouse over the functional user name you want to remove, this will cause a trash icon to appear next to it.
  2. Click on the trash icon.

If everything went ok, the functional user will be removed and the Select user... link will be displayed again.

Updating a Consumer.

Besides the functional user, the only field that can be updated by direct means is Trusted, this field is presented on the Authorized keys table with a checkbox, you only need to check it or uncheck it to modify its value permanently. To modify the consumer key, name or secret:

  1. Follow the Removing a Consumer procedure.
  2. Follow the Registering a Consumer procedure again with the updated information.

Accepting/Rejecting Provisional Keys.

If a remote friend application requested a provisional key, such request will be waiting an approval/rejection from the Jira server administrator. The friend application won't be able to connect to Jira while this request is not approved. To approve/reject provisional key requests:

  1. Enter to the JIRA ADMINISTRATION > Manage apps page.
  2. On the left panel, click on the Consumers option in the OSLC Connect section.
  3. Locate the Provisional keys section and table in the middle of the center panel.
  4. Choose the provisional key you are interested in and click on the corresponding icon, located on the third column of the table, depending on what you want to do:

If you chose to accept the request, the key entry will be moved to the Authorized keys section and table; otherwise it will be removed from the current table. Note: provisional-key consumers will be trusted or untrusted depending on how they were requested; if you want to change this, follow the Updating a Consumer steps.