OAuth/OpenID Single Sign On (SSO) into Jira using ADFS

3.1 Identifying Correct Attributes

• Access the App Configuration tab and click on Test Configuration.
• In the pop-up that appears, review the table displaying all values returned by your OAuth/OpenID Provider to Jira. If essential attributes like First Name, Last Name, Email, or Username are missing, adjust the settings in your OAuth/OpenID Provider accordingly.
• Once you've confirmed all values in the Test Configuration popup window, proceed to the User Profile tab.

3.2 Configuring Profile Attributes

• It's essential to set up both Username and Email if you allow user registration. Alternatively, you can restrict login to existing users by deselecting the Allow User Creation option in the Advanced SSO Options tab.
• You’ll be able to configure these rules in the Redirection Rules section.

3.3 User Attribute Mapping

When a user logs into Jira, data or attributes from the OAuth/OpenID provider are used to search for that user in Jira and facilitate login. To match the attributes:

• Navigate to the User Profile tab.
• Choose either Username or Email as the login for the Jira user account.
• Enter the attribute name from the OAuth/OpenID Provider that corresponds to the Username or Email as identified in the Identifying Correct Attributes step.

3.4 Custom Attribute Mapping

You can configure custom attributes received in the OAuth/OpenID response using the Configure User Properties(Extended Attributes) section.

• Click on Add Attribute Mapping.
• Enter the attribute name( E.g. department) as User Property Key in the Select Jira Attribute to Map field.
• For each attribute, input the corresponding value retrieved from the Attributes from IDP tab in the Test Configuration window. For example, if the attribute name in the Test Configuration window is Department, enter Department as the Attribute Value.
• Additional attributes, such as location, can be added by selecting the Add Attribute Mapping option.

4.1 Setting the Default Group

• In the User Groups tab, select the default group for users. If no group is mapped, users are automatically added to this group.
• Using the Assign Default Group To option, you can assign default groups to all users or new users. Choose None if you prefer not to assign any default group to SSO users.

4.2 Finding Group Attribute

• To identify group Attribute, go to the App Configuration tab and click on Test Configuration. Review the values returned by your OAuth/OpenID provider to Jira in the table. If group values are missing, adjust the settings in your OAuth provider to include group names.
• After reviewing all values in Test Configuration, proceed to the User Groups tab. Enter the Attribute Name of the group under Group Attribute.
• Check Disable Group Mapping option if you don't want to update groups of existing users.

4.3 Group Mapping

Group mapping can be done manually or on the fly:

• Manual group mapping: If the names of groups in Jira are different than the corresponding groups in OAuth/OpenID Provider, then you should use Manual group mapping.
• On-The-Fly group mapping: If the names of groups in Jira and OAuth/OpenID Provider are same, you should use On-The-Fly group mapping.

I. Manual group mapping

• Check the Allow User Creation based on Group Mapping option if you want new users to be created only if at least one of the user's OAuth/OpenID Provider groups is mapped to a group in the application.
• Select a Jira group from the dropdown list and enter the name of the OAuth/OpenID Provider group to be mapped in the Groups from Applications textbox.
• For instance, if you want all users in the 'dev' group of OAuth/OpenID providers to be added to jira-software-users, you will need to select jira-software-users from the dropdown and enter 'dev' against jira-software-users.
• You can use the '+' and '+10' buttons to add extra mapping fields, and the '-' button to delete mappings.

II. On-The-Fly group mapping

• If the group names in both Jira and the OAuth/OpenID provider match, opt for On-The-Fly group mapping.
• Check the Create New Groups option to create new groups from the OAuth/OpenID Provider if not found in Jira.
• Preserve existing user groups by selecting the Keep Existing User Groups option. Unticking this option will remove the user from a Jira group if it's not present in the OAuth/OpenID response.
• Deselect the Keep Existing User Groups option to prevent On-The-Fly group mapping from affecting locally managed Jira groups. Add those groups to the Exclude Groups field.

6.1 Sign In Settings

Refer to the handbook for a detailed breakdown of features in the Sign In Settings.

• Enable Auto Redirect to Application to redirect users to the OAuth/OIDC provider when accessing the Jira login page. You can set a delay before redirection.
• Next, toggle the Enable Backdoor Login option for emergency access using a backdoor URL. Restrict access to this URL for specific groups if needed.
• You can use Domain Restriction to allow login for specific user domains and configure multiple allowed domains (semicolon-separated).
• The Secure Admin Login option ensures the re-authentication of admin users before accessing pages with administrative permissions.

6.2 Header-Based Redirection

Refer to the handbook for a detailed breakdown of features in the Header-Based Redirection.

• Header-based redirection allows you to automatically redirect users to a specific provider based on HTTP headers present in the incoming request.
• It eliminates the need for manual provider selection by evaluating custom headers and directing users accordingly, ensuring a seamless and efficient authentication experience.

6.3 Redirection Rules

Refer to the handbook for a detailed breakdown of features in the Redirection Rules.

• Redirection rules allow you to redirect users to login pages/providers based on their email domains, groups, or directories. This functionality is especially useful with multiple configured providers.
• To create a new rule, go to the Redirection Rules tab and click Add Rule.

• Next, give the rule a name and set the conditions for redirection. Click Save once you’re done.

• You can also set a default rule if no other rule conditions are met.

• Once you set a redirection rule, users who fulfill its conditions will be shown a login form, prompting them to input their username/email address. You can set domain-based rules for directing users to specific providers as well.

6.4 Global SSO Settings

Refer to the handbook for a detailed breakdown of features in the Global SSO Settings.

• You can enable/disable SSO for Jira Software and Service Desk from the Global SSO Settings tab.
• If enforcing SSO for Service Desk Agents only, select Enable SSO Only For Service Desk Agents.
• You have the option to activate SSO for both Jira software and service desk by selecting Enable SSO for Jira Software and Enable SSO for Jira Service Desk respectively.
• The app also gives you options to adjust additional settings like Allow Users to Change Password, Restrict Access to Plugin APIs, and Auto Activate Users on SSO.
• To keep users logged in until explicitly logged out, you can enable Remember Me-Cookie in the Session Management tab.

6.5 Look and Feel

Refer to the handbook for a detailed breakdown of features in the Look and Feel.

• You can customize the appearance of your login page and error messages from the Look and Feel tab.
• The plugin has provisions for modifying the default login button text and designing the login page using customisable templates.

• You can also set a Custom Logout URL from the Post Logout Configuration tab to redirect users to a specific screen after they logout.
• The SSO Error Message section allows you to customize the error message displayed to users.

6.6 Post Logout Configuration

Refer to the handbook for a detailed breakdown of features in the Post Logout Configuration.

• You can also set a Custom Logout URL from the Post Logout Configuration tab to redirect users to a specific screen after they logout.

User Attribute Matching

When a user logs into Jira, data or attributes from the OAuth/OpenID provider are used to search for that user in Jira and facilitate login. To match the attributes:

• Navigate to the User Profile tab.
• Choose either Username or Email as the login for the Jira user account.
• Enter the attribute name from the OAuth/OpenID Provider that corresponds to the Username or Email as identified in the Identifying Correct Attributes step.

Custom Attribute Mapping

You can configure custom attributes received in the OAuth/OpenID response using the Configure User Properties(Extended Attributes) section.

• Click on Add Attribute Mapping.
• Enter the attribute name( E.g. department) as User Property Key in the Select Jira Attribute to Map field.
• For each attribute, input the corresponding value retrieved from the Attributes from your OAuth provider tab in the Test Configuration window. For example, if the attribute name in the Test Configuration window is Department, enter Department as the Attribute Value.
• Additional attributes, such as location, can be added by selecting the Add Attribute Mapping option.

4.1 Setting the Default Group

• In the User Groups tab, select the default group for users. If no group is mapped, users are automatically added to this group.
• Using the Assign Default Group To option, you can assign default groups to all users or new users. Choose None if you prefer not to assign any default group to SSO users.

4.2 Finding Group Attribute

• To identify group Attribute, click on Test Configuration. Review the values returned by your OAuth/OpenID provider to Jira in the table. If group values are missing, adjust the settings in your OAuth provider to include group names.
• Check Enable Group Mapping option if you disable this then group mapping wont be updated for existing users.

4.3 Group Mapping

Group mapping can be done manually or on the fly:

• Manual group mapping: If the names of groups in Jira are different than the corresponding groups in OAuth/OpenID Provider, then you should use Manual group mapping.
• On-The-Fly group mapping: If the names of groups in Jira and OAuth/OpenID Provider are same, you should use On-The-Fly group mapping.

I. Manual group mapping

• Check the Allow User Creation based on Group Mapping option if you want new users to be created only if at least one of the user's OAuth/OpenID Provider groups is mapped to a group in the application.
• Select a Jira group from the dropdown list and enter the name of the OAuth/OpenID Provider group to be mapped in the Groups from Applications textbox.
• For instance, if you want all users in the 'dev' group of OAuth/OpenID providers to be added to jira-software-users, you will need to select jira-software-users from the dropdown and enter 'dev' against jira-software-users.
• If you want to add extra mapping fields, click on Add Groups button.

II. On-The-Fly group mapping

• If the group names in both Jira and the OAuth/OpenID provider match, opt for On-The-Fly group mapping.
• Check the Create New Groups option to create new groups from the OAuth/OpenID Provider if not found in Jira.
• Preserve existing user groups by selecting the Keep Existing User Groups option. Unticking this option will remove the user from a Jira group if it's not present in the OAuth/OpenID response. However, you can exclude some groups from removal in the Exclude Groups field.

6.1 Sign In Settings

Refer to the handbook for a detailed breakdown of features in the Sign In Settings.

• Enable Auto Redirect to Application to redirect users to the OAuth/OIDC provider when accessing the Jira login page. You can set a delay before redirection.
• Next, toggle the Enable Backdoor Login option for emergency access using a backdoor URL. Restrict access to this URL for specific groups if needed.
• You can use Domain Restriction to allow login for specific user domains and configure multiple allowed domains (semicolon-separated).
• The Secure Admin Login option ensures the re-authentication of admin users before accessing pages with administrative permissions.

6.2 Header-Based Redirection

Refer to the handbook for a detailed breakdown of features in the Header-Based Redirection.

• Header-based redirection allows you to automatically redirect users to a specific provider based on HTTP headers present in the incoming request.
• It eliminates the need for manual provider selection by evaluating custom headers and directing users accordingly, ensuring a seamless and efficient authentication experience.

How It Works

• The specified header name must be present in the request. Header names are case-insensitive.
• The header value is evaluated using a regular expression.
• If the header value is left empty, the rule matches any value for that header.
• Rules are processed in a top-to-bottom order.
• The first matching rule determines which provider is used for redirection.
• If multiple headers with the same name exist in the request, only the first header value is evaluated.

6.3 Redirection Rules

Refer to the handbook for a detailed breakdown of features in the Redirection Rules.

• Redirection rules allow you to redirect users to login pages/providers based on their email domains, groups, or directories. This functionality is especially useful with multiple configured providers.
• To create a new rule, go to the Redirection Rules tab and click Add Rule.

• Next, give the rule a name and set the conditions for redirection. Click Save once you’re done.

• You can also set a default rule if no other rule conditions are met.

• Once you set a redirection rule, users who fulfill its conditions will be shown a login form, prompting them to input their username/email address. You can set domain-based rules for directing users to specific providers as well.

6.4 Global SSO Settings

Refer to the handbook for a detailed breakdown of features in the Global SSO Settings.

• You can enable/disable SSO for Jira Software and Service Desk from the Global SSO Settings tab.
• You have the option to activate SSO for both Jira software and service desk by selecting Enable SSO for Jira Software and Enable SSO for Jira Service Desk respectively.
• The app also gives you options to adjust additional settings like Allow Users to Change Password, Restrict Access to Plugin APIs, and Auto Activate Users on SSO.
• To keep users logged in until explicitly logged out, you can enable Remember Me-Cookie in the Session Management tab.

6.5 Look and Feel

Refer to the handbook for a detailed breakdown of features in the Look and Feel.

• You can customize the appearance of your login page and error messages from the Look and Feel tab.
• The plugin has provisions for modifying the default login button text and designing the login page using customisable templates.

• You can also set a Custom Logout URL from the Post Logout Configuration tab to redirect users to a specific screen after they logout.
• The SSO Error Message section allows you to customize the error message displayed to users.

6.6 Post Logout Configuration

Refer to the handbook for a detailed breakdown of features in the Post Logout Configuration.

• You can also set a Custom Logout URL from the Post Logout Configuration tab to redirect users to a specific screen after they logout.