Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

An API key may be created for each Jira user. Each API key contains a "Client Id" and a "Client Secret" which can be used afterwards during the authentication phase.

From thereon, authenticated REST API requests will be done in the name behalf of the user linked to the API key being used

...

Table of Contents

Single operations

Create an API Key

...

  1. Click on the "Create API Key" button.
  2. Select the user and click on "Generate".
  3. If no API Key already exists for that user, a new API Key will be created and linked to the that user. A "Client Id" and a "Client Secret" will be generated, which can then be used for authenticaiton purposes.

Delete an API Key

An existing API Key can be deleted as follows:

  1. Click on the action icon on the right -side of the table entry and choose "Delete". Choose Delete.
  2. Confirm by clicking on "Delete" in the confirmation dialog Delete.

Regenerate Client Secret

An existing API Key can be deleted as follows:

  1. Click on the action icon on the right -side of the table entry and choose ". Choose Regenerate Client Secret".
  2. Click Confirm by clicking on "Confirm" in the confirmation dialog.

Bulk operations

Select API Keys

Bulk selection of API Keys can be achieved either from the top picker or by individually checking the API Keys within the table.

   


Whenever some API Keys are selected, an action button , near the bulk selection icon , will enumerate list the available bulk actions.

...

Multiple API Keys may be deleted as follows:

  1. bulk select Select one or more API Keys, either by using the bulk action icon or by individually checking the API Keys within the table
  2. In the button that shows the amount number of selected API Keys, click on "Delete".
  3. Confirm by clicking on "Delete".

Regenerate Client Secret

Multiple The Client Secret of multiple API Keys may be deleted regenerated as follows:

  1. bulk select Select one or more API Keys, either by using the bulk action icon or by individually checking the API Keys within the table
  2. In the button that shows the amount number of selected API Keys, click on "Regenerate Client Secret".
  3. Click Confirm.Confirm by clicking on "Confirm"