PingFederate. Identity Menu Builder. User Guide. Version 1.0

Transcription

1 Identity Menu Builder Version 1.0 User Guide

2 2011 Ping Identity Corporation. All rights reserved. Identity Menu Builder User Guide Version 1.0 April, 2011 Ping Identity Corporation th Street, Suite 2950 Denver, CO U.S.A. Phone: ( outside North America) Fax: Web Site: Trademarks Ping Identity,, the icon, and the Ping Identity logo are trademarks or registered trademarks of Ping Identity Corporation. All other trademarks or registered trademarks are the property of their respective owners. Disclaimer This document is provided for informational purposes only, and the information herein is subject to change without notice. Ping Identity Corporation does not provide any warranties and specifically disclaims any liability in connection with this document.

3 Contents Introduction Preparation Installation Using the Identity Menu Builder Accessing the Identity Menu Builder Selecting the Connectors Deploying Your Logon Menu Alternate Installation Identity Menu Builder 3 User Guide

4 Introduction The Identity Menu Builder automates Web-application development for a Service Provider (SP) to fully implement consumer single sign-on (SSO) via any or all of s Cloud Identity Connectors. Using a Web service, the Menu Builder obtains a list of configured Connectors from which it generates a dynamic HTML logon menu containing familiar icons (for example, social-networking logos). Customers can click an icon for access to an SP application using the third-party site as the Identity Provider (IdP). Intended Audience This document is intended for Web developers with experience in the configuration and maintenance of Web applications. Some exposure to the administrative console may be helpful. Additional Resources If you encounter any difficulties with configuration or deployment, please try searching the Ping Identity Support Center ( ZIP Manifest The distribution ZIP file for the Identity Menu Builder contains the following: GettingStarted.pdf - contains the following information. Links to this online documentation Copyright and license information /dist - contains libraries needed for the Menu Builder: identity-menu-builder.war - Identity Menu Builder Web Archive. cloud-connector-loaders-1.0.jar - Java class files used for identifying Cloud Identity Connectors. System Requirements The Identity Menu Builder requires the installation and configuration of 6.5 or higher and at least one configured Cloud Identity Connector. Preparation A Administrator must complete the following tasks prior to implementing the Identity Menu Builder: Download and configure at least one Cloud Identity Connector from the Ping Identity Web site. Ensure the SSO Directory Service is activated: The Identity Menu Builder uses this service to retrieve a list of configured Cloud Identity Connectors that can be used for building your log on menu. On the Main Menu, click Application Authentication under Security in the System Settings section. Identity Menu Builder 4 User Guide

5 If the service is already activated (under Action for SSO Directory Service) and credentials are present, obtain the Id and Shared Secret from the Administrator for use as Menu Builder logon credentials. If the credentials are unset or leftover from the QuickStart application (heuristics/changeme1), you can choose whether to set credentials. The SSO Directory Service can be active without requiring authentication. Click Save when you finish with the screen. Installation The following section describes how to install and set up the Identity Menu Builder in the directory. Note: You can install the Identity Menu Builder into any Java-application server for example, Tomcat. For more information on installing the Identity Menu Builder in its own container, see Alternate Installation on page 8. To install the Identity Menu Builder: 1. From the dist/ directory, copy: cloud-connector-loaders-1.0.jar identity-menu-builder.war into the directory: <PF-install>/server/default/deploy 2. Start or restart. (For more information, see Starting and Stopping in the Administrator s Manual.) Using the Identity Menu Builder Use the Identity Menu Builder to select and arrange the Cloud Identity Connectors you want to use, to copy the generated HTML code for integration into your company portal page, and to download a ZIP file containing images and a sample CSS file. Accessing the Identity Menu Builder When the Identity Menu Builder is installed with : Access the Menu Builder at http[s]://<pf_host>:<pf_port>/identity-menu-builder/ If you are prompted to log on, use the Id and Shared Secret defined for the SSO Directory Service (see Preparation ) and click Login. Identity Menu Builder 5 User Guide

6 Selecting the Connectors Use this page to define the Cloud Identity Connectors you want to include on your logon menu, the order in which you want the connector images to appear in the menu, and the path to your Web application, which allows the Identity Menu Builder to integrate the location into the generated code. A list of configured Cloud Identity Connector IdP Adapters appears in the Cloud Identity Connectors section. The text included below each icon indicates how the adapter is configured: Adapter to Adapter or Partner Connection. (For more information, see any Cloud Identity Connector User Guide.) Note: If more than one instance of a Connector displays, contact your Administrator to differentiate between the two instances for your company portal page. 1. Select the checkboxes for the adapters you want to use. As you select an adapter checkbox, a corresponding icon appears in the Sort your services section. 2. Drag the icons to arrange them into the order you want them to appear. 3. Use the Application Context box to define the root or subdirectory where you want to save the Menu Builder files. The Menu Builder files consist of images and a cascading style sheet (CSS). 4. Click Submit. Note: If you do not define the path to your Web application here, you will need to alter the code generated by the Identity Menu Builder manually to point to the appropriate location. Identity Menu Builder 6 User Guide

7 Deploying Your Logon Menu Use this page to copy the generated code and to download a ZIP file of images and the sample CSS file for integrating into your company portal page. The Preview section on the right provides an example of your logon menu. You can click an icon to watch the adapter perform SSO. Note: You may be presented with a text box when clicking the OpenID or Google Apps icon. This text box appears when no domain name is specified in the Adapter configuration within. Enter the domain name into the text box and click Sign in to continue with the adapter SSO preview. 1. Click Copy to Clipboard in the Cloud Identity Connector Code section. Note: If your browser does not currently have Flash or Shockwave installed, you may be prompted to install these products when you click Copy to Clipboard. 2. Paste the HTML into a new editor file and use to integrate into your company portal page. Tip: Commented sections (Required SSO elements and Required SSO functions) are included in the HTML code that point to sections containing important elements. 3. Click ZIP with Sample CSS and Images to download the ZIP file containing a sample CSS file as well as the images needed for the Cloud Identity Connector icons. 4. Unzip the file in the directory you defined in the Application Context box on the previous page. Identity Menu Builder 7 User Guide

8 Alternate Installation You can deploy the Identity Menu Builder into its own container (such as Tomcat), rather than the container running. To do this, you must change a configuration file, and you may need to update the Trusted CAs in with the container s SSL server certificate. Note: This configuration requires some familiarity with Web-application deployment and the targetcontainer configuration, as well as SSL certificate management. 1. In the server directory structure, locate the config.properties file contained in: identity-menu-builder.war/config/ 2. Change the pf.runtime.url property in the file to the hostname and port where the Runtime is installed in the format: http[s]://<pf_host>:<pf_port> where: <pf_host> is the machine running <pf_port> is the port For example: pf.runtime.url= 3. You may need to import the container s SSL server certificate into the Trusted CAs, depending on the container s SSL configuration, and ensure the container server trusts the certificate. For more information, see Security Management in the Administrator s Manual. 4. Restart the server where the Identity Menu Builder is installed. Identity Menu Builder 8 User Guide