Atlassian Jira Auth Module
This authentication module lets users log in to Hub with their Jira accounts.
Enable Jira Authentication
To allow users to sign in to Hub with their Jira accounts, enable a Jira authentication module.
To enable the module, follow these steps.
To enable Jira authentication:
In the Access Management section of the Administration menu, select .
From the Add Module drop-down list, select Atlassian Jira.
The Add Module dialog opens.
In the Add Module dialog, enter values for the following settings:
Field
Description
Name
Enter a name for the authentication module.
Server URL
Enter the server address of the Jira instance. For example,
https://mycompany.com/jira.The Jira authentication module is created, enabled, and configured automatically.
The Auth Modules page displays the settings for the Jira authentication module. For additional information about the settings on this page, see the Settings section.
Users can log in to Hub with their Jira credentials.
Test the Connection
To verify that the authentication module is connected to your Jira instance, test the connection.
Click the Test Login button.
In the Test Authentication dialog, enter the credentials of a user who is stored in your Jira instance:
In the Username field, enter the
domainusername.In the Password field, enter the
password.
Click the Test Login button.
Hub searches for the specified user account in the Jira instance. If the user is found, a success notification is displayed. If you get an error, check your user credentials and server URL.
Settings
The settings are configured automatically when the module is added to Hub. You do not have to change these settings. To configure the options that define how Hub treats new user accounts with Jira credentials, see Additional Settings.
Field | Description |
|---|---|
Type | Displays the name of the application or service that is enabled for third-party authentication in Hub. |
Name | Stores the name of the authentication module. Use this setting to distinguish this module from other authentication modules in the Auth Modules list. The name is also shown in the tooltip for the third-party service icon on the login form. |
Server URL | Stores the URL used to authenticate a login request in Hub. |
Change Password URI | Stores the URL of the page used to manage change password requests for a Jira account. |
SSL key | Selects an SSL key that can be used to verify the identity of your YouTrack installation to Jira. You should only need to use this setting when your Jira installation requires client SSL authentication. For more information about managing SSL keys in YouTrack, see SSL Keys. |
Additional Settings
These settings let you manage Hub account creation and group membership, and to reduce the loss of processing resources consumed by idle connections.
Option | Description |
|---|---|
User creation | Enables creation of Hub accounts for unregistered users who log in with an account that is stored in the connected authorization service. Hub uses the email address to determine whether the user has an existing account. |
Auto-join groups | Adds users to a group when they log in with an account that is stored in the connected authorization service. You can select one or more groups. New users that auto-join a group inherit all the permissions assigned to this group. We recommend that you add users to at least one group. Otherwise, a new user is only granted the permissions that are currently assigned to the All Users group. |
Connection timeout | Sets the period of time to wait to establish a connection to the authorization service. The default setting is 5000 milliseconds (5 seconds). |
Read timeout | Sets the period of time to wait to read and retrieve user profile data from the authorization service. The default setting is 5000 milliseconds (5 seconds). |
Audit | Links to the Audit Events page in Hub. There, you can view a list of changes that were applied to this authentication module. |
Actions
The following actions are available in the header:
Action | Description |
|---|---|
Set default | Designates the authentication module as the default for your installation. Only one authentication module can be set as the default at any time. If another module is currently set as the default, that state is cleared. This option is only shown when the current authentication module is not designated as the default. |
Clear default | Removes the authentication module as the default for your installation. If none of the available authentication modules are designated as the default, unauthenticated users are always directed to the Hub login page. This option is only shown when the current authentication module is designated as the default. |
Disable module | Disables the authentication module. This option is only shown when the authentication module is currently enabled. |
Enable module | Enables the authentication module. This option is only shown when the authentication module is currently disabled. |
Test login | Lets you test the connection with the authentication service. |
Delete module | Removes the authentication module from Hub. Use only when you have configured additional authentication modules that let users log into your Hub installation. |