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 possible generates/updates) the information of Jira (through this plugin) using an authorized Jira user.

Consumers are needed to create incoming collaboration links; this means you need to register the Remote OSLC Application as a consumer of Jira, if you want to create collaboration links on the Remote OSLC 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 a consumer is not bound to any particular Jira user, it has its own identity and, at the proper working moment, it will request a Jira user credentials to work on behalf of it (a process known as "user authentication"). Consumers identify themselves with a Key, in this sense there are two types of consumers (depending on the type of its Key):

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

Another way of categorize 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 [3].

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. On the left panel, click on the Consumers option in the OSLC section.
  2. Click on the Add Consumer button at the top of the right panel.
  3. Fill out the form on the Add Consumer dialog according to the following field descriptions (suggested values assume you are configuring this consumer for SECollab, feel free to adjust them accordingly to your real Remote OSLC Application):
    Field Required Description Notes Suggested Value
    Name Yes Logical name for human identification. Commonly the client application name. SECollab
    Key No Unique consumer identifier. Plugin will generate one for you if not provided. SECollab
    Secret Yes Consumer password. Along with Key, required for consumer authentication. Whatever you want that you don't forget.
    Confirmation Yes Password confirmation. Just a confirmation field to avoid password typos. The same as Secret field.
    Trusted Yes Whether consumer will be trusted or not. Check to avoid extra user authorization on each session. checked
  4. Click on the Add button.

If everything went ok, a new consumer entry will be displayed on the Authorized keys section; note: only the Consumer Name, Consumer Key and Trusted fields will be shown. 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. On the left panel, click on the Consumers option in the OSLC section.
  2. Locate the Authorized keys section and table at the bottom of the center panel.
  3. Choose the consumer you want to remove and click on the corresponding trash icon located on the fourth column of the table.

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

Updating a Consumer.

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 any other field you need to:

  1. Remove the consumer.
  2. Register it again with the updated information.

Accepting/Rejecting Provisional Keys.

  1. On the left panel, click on the Consumers option in the OSLC section.
  2. Locate the Provisional keys section and table at the middle of the center panel.
  3. Choose the provisional key you are interested of 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.