Skip to content

Latest commit

 

History

History
78 lines (41 loc) · 4.86 KB

README.md

File metadata and controls

78 lines (41 loc) · 4.86 KB
Raw

Match AAD Centered Login Page

Overview

This project provides an ADFS style sheet to allow your ADFS UI to be consistent with the new Azure AD Centered UI experience.

Note that this customization comes in two parts. The first is a style sheet, which allows the look-and-feel of your ADFS to match the AAD Centered UI experience. The second is a more advanced customization, using the ADFS JavaScript customization feature to create a front-end paginated sign-in experience.

Getting Started

We will break the deployment of this feature into two parts. First, the style sheet to create a consistent look-and-feel. Second, the JavaScript to create a front-end paginated experience. You can choose if you wish to deploy one or both.

Getting Started - Style Sheet Deployment

  1. Download the ThemeCenterBrand.css file to your ADFS server, wherever you host your style sheets. Note: It is recommended that you minify your CSS for a production environment

  2. Create a custom web theme using the following command in PowerShell:

    New-AdfsWebTheme –Name custom -SourceTheme default –StyleSheet @{path=”c:\style\ThemeCenterBrand.css”}

  3. Apply the new custom web theme using the following command in PowerShell:

    Set-AdfsWebConfig -ActiveThemeName custom

  4. Update the logo and background image. For details and image size recommendations, see this post

Getting Started - JavaScript Deployment

  1. Download the paginatedOnload.js file to your ADFS server, wherever you host your JavaScript.

    Note: It is highly recommended that you minify your paginatedOnload.js before including it in a production environment. There are many popular tools online for minifying JavaScript code. Two popular choices are minifier.org and JSCompress.

  2. Modify your existing custom web theme from the style sheet deployment to include the new JavaScript. In PowerShell:

    Set-AdfsWebTheme –TargetName custom -AdditionalFileResource @{Uri=’/adfs/portal/script/onload.js’; path="c:\paginatedOnload.js"}

  3. Apply the modified custom web theme using the following command in PowerShell:

    Set-AdfsWebConfig -ActiveThemeName custom

  4. For more information on JavaScript customization, see Advanced ADFS Customization

Additional JavaScript Changes

The JavaScript we provide out-of-the-box does not provide two key features you may want.

  1. The JavaScript works for deployments in most major languages. However, if you wish to have your pages work under other languages, you will need to follow the steps below in Supporting Non-English Languages

  2. The new paginated sign in contains a user avatar image. By default, this image is a standard empty user avatar (shown below). To support user avatar lookup, you will need to follow the steps below in Supporting User Avatar Lookup

    Empty User

Supporting Non-English Languages

In order to support non-English languages, you will need to add translated text for the new UI items that are created by the JavaScript.

In the code, you should locate the translation table in the function GetLocalizedStringForElement. You should add translations for the text in the translation table.

Each translation should be mapped to the correct language code. For a reference on language codes, see the ISO 639-1 Code column in the table at this resource.

Supporting User Avatar Lookup

The AAD experience includes a user avatar on the password page, on the right side of the banner. ADFS does not have support for the concept of a user avatar, so it's not possible to include this logic out-of-the-box. If you wish to support this behavior, you will have to build a web API that accepts a username, and returns an image. You will then have to update the paginatedOnload.js code to make the request for the user avatar image, and handle the response.

If you are interested in working with the ADFS Open Source community to build a user avatar web app, please contact [email protected]

Example

Login Screenshot

Contributing (Special Note)

If you find any problems with the CSS, JavaScript, or docs, please fork and send us your fix. If you don't have a fix, please open an issue, and describe what you are seeing (feel free to include screenshots).

For the full Contributing details, please see the root README.