JIRA 11.0.0+

The authentication schemes offered when an administrator defines a JIRA instance are pluggable: the extension ships "No authentication" and "Basic auth", and a new scheme adds itself to that list. A scheme has two halves that are tied together by a single identifier: a user interface extension contributing the fields the administrator fills, and a Java Component signing the requests with them. The Basic authentication scheme is the working example to copy, its user interface under JIRA.JIRAAuth and its Component at BasicAuthJIRAAuthenticatorFactory.

1. Choose the identifier of your scheme, which will tie its two halves together, for example oauth.
2. Create a page holding an XWiki.UIExtensionClass xobject whose "Extension Point ID" is org.xwiki.contrib.jira.authconfig, whose "Extension Scope" is wiki, and whose name is unique among the schemes.
3. Set the three parameters of that user interface extension.

   Parameter	Value
   config_id	The identifier you chose.
   translation_key	The translation key of the name shown in the "Authentication type" field.
   config_displayer_reference	The reference of the page displaying your scheme's own fields under "Authentication system configuration".

4. Create the page named by config_displayer_reference, displaying one form field per piece of information your scheme needs, and an XClass to store them keyed by the instance id.
5. Add the translation of translation_key to a translation bundle of your extension.
6. Write a Java Component implementing org.xwiki.contrib.jira.config.JIRAAuthenticatorFactory, annotated @Named with the identifier you chose, whose get(String serverId) method reads the stored configuration of that instance and returns a JIRAAuthenticator, or throws JIRAAuthenticatorException when it cannot.
7. Implement the four methods of org.xwiki.contrib.jira.config.JIRAAuthenticator.

   Method	Returns
   getRestClientAuthenticationHandler()	The AuthenticationHandler the JIRA Scripting API passes to Atlassian's client.
   authenticateInHttpClient(context, request, targetHost)	Nothing; it signs the HttpClient request the Macros use, for instance by adding a header.
   isAuthenticatingRequest()	Whether requests really are authenticated, which lets callers tell a configured scheme from an inert one.
   getId()	A value identifying this authentication, used to build the cache key of asynchronous Macro rendering. Make it differ whenever the resulting rights differ.

8. Install your extension, then select your scheme in the "Authentication type" field of a JIRA instance definition. Its fields appear, and issues are returned through it.