How to customize Confluence SSO login failure page.
Platform Notice: Data Center Only - This article only applies to Atlassian products on the Data Center platform.
Note that this KB was created for the Data Center version of the product. Data Center KBs for non-Data-Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Summary
❗ The information in this page relates to customizations in Confluence. Consequently, Atlassian Support cannot guarantee to provide any support for the steps described on this page as customizations are not covered under Atlassian Support Offerings. Please be aware that this material is provided for your information only and that you use it at your own risk.
Also, please be aware that customizations done by directly modifying files are not included in the upgrade process. These modifications will need to be reapplied manually on the upgraded instance.
In certain use cases, you may require a customized message to be displayed on the Confluence Single Sign-On (SSO) login failure page. This may involve including specific information or removing certain elements. As the Confluence interface does not provide an option to modify the gadget, you will need to manually edit its source files using the command line interface (CLI), such as Terminal or Command Prompt (CMD).
Solution
Process
⚠️ Always remember to backup the files you modify so you can rollback in case anything goes wrong in the process
Copy the jar file from /<confluence_installation_directory/confluence/WEB_INF/Atlassian-bundled-plugins/ com.atlassian.plugins.authentication.atlassian-authentication-plugin-4.2.31.jar to a temporary empty directory
Unzip the jar file:
1
jar xf com.atlassian.plugins.authentication.atlassian-authentication-plugin-4.2.31.jar3. Modify the file "atlassian-authentication-plugin.properties" file.
Update this section to customize your message:
1
2
3
4
5
6
7
8
#---------------------Authentication failed---------------------
authentication.failed.header=We can''t log you in right now
authentication.failed.message=Please contact your administrator. Give them this error identifier:
#---------------------Invalid Saml Assertion---------------------
authentication.invalid.assertion.header=Something went wrong
authentication.invalid.assertion.message=We couldn''t log you in. This may be for a \n variety of reasons. We suggest trying again.
authentication.invalid.assertion.text=Return to login
authentication.invalid.assertion.additional.message=If the problem persists, contact your {0} administrator. Give them this error identifier: 4. Zip the changes:
Remove the existing jar file and zip the rest to create a new jar file
1
2
3
rm com.atlassian.plugins.authentication.atlassian-authentication-plugin-4.2.31.jar
zip -r com.atlassian.plugins.authentication.atlassian-authentication-plugin-4.2.31.jar *5. Replace old jar file with new jar file:
Take the back up of original jar file and replace it with new one under /<confluence_installation_directory/confluence/WEB_INF/Atlassian-bundled-plugins/
6. Restart Confluence Service and test SSO login
⚠️PLEASE READ: As with all recommendations made by Atlassian Support, please follow best practices for Change Management and make sure to test and validate these steps in a lower environment (staging, development, testing, etc) prior to rolling any changes into a Production environment, and only after backing up your system and data. This is to validate these changes and ensure that they will function well within your infrastructure prior to placing them in production.
Also, this is categorized as customizations in Confluence. Consequently, Atlassian Support cannot guarantee to provide any support for the steps described on this page as customizations are not covered under Atlassian Support Offering. This is provided as a best effort from the Support Team.
Finally, please be aware that customizations done by directly modifying files are not included in the upgrade process. These modifications will need to be reapplied manually on the upgraded instance.
Was this helpful?