Using UAA for Application Login or Logout Window

Using UAA to Set Up Application Login or Logout

When you bind your application to UAA and set up your application users in UAA, UAA provides a login screen for the users to access your application.

You can customize the UAA login window as per your application's requirements. Your application users can use the login screen to reset their passwords if needed.

Customizing the UAA Login Window for Your Application

When you bind your UAA instance with your application to provide your application users with a login window, the default login window displays standard UAA window. The default window displays the predix logo, header, and footer information. You can customize this window for each UAA instance to suit your application's requirements.

About This Task

You can customize the UAA Login window to display the information specific to your application. You can add information such as company name, product name, and product logo. You can also update the header and footer information displayed on the login page.

To customize your login page:

Procedure

  1. In the Console view, select the Space where your services are located.
  2. In the Services Instances page, select the UAA instance that you need to configure.
  3. Select the Configure Service Instance option.
  4. In the UAA Dashboard login page, specify your admin client secret and click Login.
  5. In UAA Dashboard, select the Customization tab.
  6. Update the following values in the Customization page:
    FieldValue
    Welcome to <GUID>Replace the GUID value in the welcome message.
    NameSpecifies the name of your company, application or product.
    Upload Product LogoClick to choose a Product logo image file in PNG format to upload.
    Upload Favicon LogoClick to upload a shortcut icon or URL icon in PNG format for your application.
    FooterSpecify the text to appear as footer in your login screen.
    Footer LinksSpecify values for URLs that you need to show in your login screen.
    Logout Redirect URLSpecify a default URL value to redirect users after logout.
    Allow Logout Redirect URL OverwriteTurn this option off if you need to prevent users from specifying a redirect URI as a logout parameter. The users are then redirected to the default logout redirect URI.
    Logout Redirect Parameter WhitelistSpecify a list of redirect URLs that the users can use as logout parameter.

    For more information on other UAA configuration options, see https://docs.cloudfoundry.org/api/uaa/#retrieving-an-identity-zone.

    Note: The configuration tab in the UAA Dashboard also provides fields for setting duration for token validity and enabling automatic discovery of identity providers. For more information, see uaas-managing-tokens.html#task_yvv_twn_2v or uaas-managing-identity-providers.html#task_oct_sz2_5w.
  7. Click Save.
  8. View your login window to validate the changes.