Microsoft SharePoint Adapter Installation and Configuration Guide



Similar documents
Oracle ebs Adapter Installation and Configuration Guide

Active Directory Adapter with 64-bit Support Installation and Configuration Guide

Microsoft Office 365 Adapter Installation and Configuration Guide

Tivoli Access Manager Agent for Windows Installation Guide

Desktop Password Reset Assistant Installation and Configuration Guide

Cisco Unified Communications Manager Adapter User Guide

How To Use An Org.Org Adapter On An Org Powerbook (Orb) With An Org Idm.Org (Orber) Powerbook With An Adapter (Orbor) With A Powerbook 2 (Orbi) With The Power

IBM Security QRadar Vulnerability Manager Version User Guide

IBM Security Access Manager for Enterprise Single Sign-On Version User Guide IBM SC

IBM WebSphere Application Server Version 7.0

Tivoli Identity Manager

IBM Security Identity Manager Version 6.0. Security Guide SC

Microsoft Dynamics GP Release

Operating System Installation Guide

Authoring for System Center 2012 Operations Manager

Installation Guide: Delta Module Manager Launcher

Tivoli Monitoring for Databases: Microsoft SQL Server Agent

User's Guide - Beta 1 Draft

How To Install An Aneka Cloud On A Windows 7 Computer (For Free)

Using DC Agent for Transparent User Identification

IBM Security QRadar Vulnerability Manager Version User Guide IBM

Practice Fusion API Client Installation Guide for Windows

Scheduler Job Scheduling Console

Installation and Configuration Guide

Enhanced Connector Applications SupportPac VP01 for IBM WebSphere Business Events 3.0.0

Release Notes. IBM Tivoli Identity Manager Oracle Database Adapter. Version First Edition (December 7, 2007)

User's Guide - Beta 1 Draft

System i and System p. Customer service, support, and troubleshooting

IBM Information Server

Configuring and Integrating Oracle

RSM Web Gateway RSM Web Client INSTALLATION AND ADMINISTRATION GUIDE

WhatsUp Gold v16.3 Installation and Configuration Guide

Modular Messaging. Release 4.0 Service Pack 4. Whitepaper: Support for Active Directory and Exchange 2007 running on Windows Server 2008 platforms.

Change Management for Rational DOORS User s Guide

IBM Security QRadar Version WinCollect User Guide V7.2.2

Using LDAP Authentication in a PowerCenter Domain

Sage 200 Web Time & Expenses Guide

User Migration Tool. Note. Staging Guide for Cisco Unified ICM/Contact Center Enterprise & Hosted Release 9.0(1) 1

Tivoli Endpoint Manager for Remote Control Version 8 Release 2. User s Guide

SEER Enterprise Shared Database Administrator s Guide

Diamond II v2.3 Service Pack 4 Installation Manual

IBM SmartCloud Workload Automation - Software as a Service. Agent Installation and Uninstallation Messages

Xerox EX Print Server, Powered by Fiery, for the Xerox 700 Digital Color Press. Printing from Windows

Ingenious Testcraft Technical Documentation Installation Guide

Installing, Uninstalling, and Upgrading Service Monitor

Using Logon Agent for Transparent User Identification

Virtual CD v10. Network Management Server Manual. H+H Software GmbH

Pre-Installation Instructions

Security Service tools user IDs and passwords

Installing and Configuring DB2 10, WebSphere Application Server v8 & Maximo Asset Management

Prerequisites and Configuration Guide

IBM FileNet Image Services

Release System Administrator s Guide

Oracle Identity Manager

Design Better Products. SolidWorks SolidWorks Enterprise PDM Installation Guide

DiskPulse DISK CHANGE MONITOR

How To Enable A Websphere To Communicate With Ssl On An Ipad From Aaya One X Portal On A Pc Or Macbook Or Ipad (For Acedo) On A Network With A Password Protected (

Ipswitch Client Installation Guide

WebSphere Business Monitor V7.0: Clustering Single cluster deployment environment pattern

Ultimus and Microsoft Active Directory

Optimization in a Secure Windows Environment

EVALUATION ONLY. WA2088 WebSphere Application Server 8.5 Administration on Windows. Student Labs. Web Age Solutions Inc.

Connection and Printer Setup Guide

Portions of this product were created using LEADTOOLS LEAD Technologies, Inc. ALL RIGHTS RESERVED.

IBM Tivoli Security Administrator for RACF IBM. User s Guide. Version 1.1 SC

Sametime Gateway Version 9. Deploying DMZ Secure Proxy Server

Version 4.61 or Later. Copyright 2013 Interactive Financial Solutions, Inc. All Rights Reserved. ProviderPro Network Administration Guide.

Dell SupportAssist Version 2.0 for Dell OpenManage Essentials Quick Start Guide

Windows Server Update Services 3.0 SP2 Step By Step Guide

MadCap Software. Upgrading Guide. Pulse

PN Connect:Enterprise Secure FTP Client Release Notes Version

Firewall Security Toolbox User s Guide

DocuShare Installation Guide

Installation Guide. Release 3.1

COMMANDS 1 Overview... 1 Default Commands... 2 Creating a Script from a Command Document Revision History... 10

Installation and Configuration Guide

Fiery EX4112/4127. Printing from Windows

Installation Guide for Pulse on Windows Server 2008R2

TIBCO Spotfire Automation Services Installation and Configuration

Lesson Plans Microsoft s Managing and Maintaining a Microsoft Windows Server 2003 Environment

IBM Endpoint Manager Version 9.2. Patch Management for SUSE Linux Enterprise User's Guide

HYPERION SYSTEM 9 N-TIER INSTALLATION GUIDE MASTER DATA MANAGEMENT RELEASE 9.2

Sage 100 ERP. Installation and System Administrator s Guide

DC Agent Troubleshooting

Secure Messaging Server Console... 2

LT Auditor Windows Assessment SP1 Installation & Configuration Guide

How To Create An Easybelle History Database On A Microsoft Powerbook (Windows)

Enterprise Vault Installing and Configuring

QACenter Installation and Configuration Guide. Release 4.4.2


Citrix Access Gateway Plug-in for Windows User Guide

Sophos for Microsoft SharePoint startup guide

Introduction 1-1 Installing FAS 500 Asset Accounting the First Time 2-1 Installing FAS 500 Asset Accounting: Upgrading from a Prior Version 3-1

IBM Campaign Version-independent Integration with IBM Engage Version 1 Release 3 April 8, Integration Guide IBM

Backup Exec 15. Quick Installation Guide

TOSHIBA GA Printing from Windows

Installation Guide for Pulse on Windows Server 2012

R i o L i n x s u p p o r r i o l i n x. c o m 3 / 5 /

SQL Server 2008 R2 Express Edition Installation Guide

IBM Campaign and IBM Silverpop Engage Version 1 Release 2 August 31, Integration Guide IBM

Transcription:

IBM Security Identity Manager Version 6.0 Microsoft SharePoint Adapter Installation and Configuration Guide SC27-4416-04

IBM Security Identity Manager Version 6.0 Microsoft SharePoint Adapter Installation and Configuration Guide SC27-4416-04

Note Before using this information and the product it supports, read the information in Notices on page 47. Edition notice Note: This edition applies to version 6.0 of IBM Security Identity Manager (product number 5724-C34) and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright IBM Corporation 2012, 2014. US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Contents Figures............... v Tables............... vii Preface............... ix About this publication........... ix Access to publications and terminology..... ix Accessibility.............. x Technical training............. x Support information............ x Statement of Good Security Practices...... x Chapter 1. Overview of the adapter... 1 Features of the adapter........... 1 Architecture of the adapter......... 1 Supported configurations.......... 2 Chapter 2. Adapter installation planning and configuration.......... 5 Preinstallation roadmap.......... 5 Installation roadmap............ 5 Prerequisites.............. 6 Installation worksheet for the adapter...... 7 Software download for the SharePoint adapter... 7 Chapter 3. Adapter installation..... 9 Dispatcher installation verification....... 9 Installing the adapter........... 9 Authentication providers configuration..... 10 Installation verification.......... 12 Start, stop, and restart of the SharePoint adapter service................ 12 Importing the adapter profile into the IBM Security Identity Manager server.......... 13 Adapter profile installation verification..... 14 Adapter user account creation........ 14 Creating a service............ 14 Chapter 4. First steps after installation 19 Adapter configuration........... 19 Editing adapter profiles on the UNIX or Linux operating system........... 19 Creating a JAR file and importing the profile on the IBM Security Identity Manager..... 20 Language pack installation for the SharePoint adapter................ 20 Verification that the SharePoint adapter is working correctly............... 20 Chapter 5. Troubleshooting the adapter errors............... 23 Techniques for troubleshooting problems.... 23 Chapter 6. Adapter upgrade...... 27 Connector upgrade............ 27 Profile upgrade............. 27 Chapter 7. Adapter uninstallation... 29 Uninstalling the adapter from the Tivoli Directory Integrator server............. 29 Adapter profile removal from the IBM Security Identity Manager server.......... 29 Chapter 8. Adapter reinstallation... 31 Appendix A. Adapter usage screens.. 33 Group creation............. 33 Group reconciliation........... 33 Group modification............ 33 Group deletion............. 33 User creation.............. 34 User reconciliation............ 34 User modification............ 34 User deletion.............. 34 Appendix B. Adapter attributes.... 35 Attribute descriptions........... 35 Appendix C. Definitions for ITDI_HOME and ISIM_HOME directories...... 39 Appendix D. Support information... 41 Searching knowledge bases......... 41 Obtaining a product fix.......... 42 Contacting IBM Support.......... 42 Appendix E. Accessibility features for IBM Security Identity Manager.... 45 Notices.............. 47 Index............... 51 Copyright IBM Corp. 2012, 2014 iii

iv IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Figures 1. The architecture of the Microsoft SharePoint Adapter.............. 2 2. Example of a single server configuration... 3 3. Example of multiple server configuration 3 Copyright IBM Corp. 2012, 2014 v

vi IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Tables 1. Preinstallation roadmap......... 5 2. Installation roadmap.......... 5 3. Prerequisites to install the adapter..... 6 4. Required information to install the adapter 7 5. Supported SharePoint Servers and corresponding authentication providers... 10 6. Authentication providers listed in the example 11 7. Adapter component.......... 12 8. Required group creation fields...... 33 9. Required attributes for creating a user... 34 10. Supported attributes......... 35 11. Supported object classes........ 38 Copyright IBM Corp. 2012, 2014 vii

viii IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Preface About this publication The Microsoft SharePoint Adapter Installation and Configuration Guide provides the basic information that you can use to install and configure the IBM Security Identity Manager Microsoft SharePoint Adapter. IBM Security Identity Manager was previously known as Tivoli Identity Manager. The adapter enables connectivity between the IBM Security Identity Manager server and the managed resource. Access to publications and terminology This section provides: v A list of publications in the IBM Security Identity Manager library. v Links to Online publications. v A link to the IBM Terminology website. IBM Security Identity Manager library For a complete listing of the IBM Security Identity Manager and IBM Security Identity Manager Adapter documentation, see the online library (http://www-01.ibm.com/support/knowledgecenter/ssrmwj/welcome). Online publications IBM posts product publications when the product is released and when the publications are updated at the following locations: IBM Security Identity Manager library The product documentation site (http://www-01.ibm.com/support/ knowledgecenter/ssrmwj/welcome) displays the welcome page and navigation for the library. IBM Security Systems Documentation Central IBM Security Systems Documentation Central provides an alphabetical list of all IBM Security Systems product libraries and links to the online documentation for specific versions of each product. IBM Publications Center The IBM Publications Center site ( http://www-05.ibm.com/e-business/ linkweb/publications/servlet/pbi.wss) offers customized search functions to help you find all the IBM publications you need. IBM Terminology website The IBM Terminology website consolidates terminology for product libraries in one location. You can access the Terminology website at http://www.ibm.com/ software/globalization/terminology. Copyright IBM Corp. 2012, 2014 ix

Accessibility Technical training Support information Accessibility features help users with a physical disability, such as restricted mobility or limited vision, to use software products successfully. With this product, you can use assistive technologies to hear and navigate the interface. You can also use the keyboard instead of the mouse to operate all features of the graphical user interface. For technical training information, see the following IBM Education website at http://www.ibm.com/software/tivoli/education. IBM Support provides assistance with code-related problems and routine, short duration installation or usage questions. You can directly access the IBM Software Support site at http://www.ibm.com/software/support/probsub.html. Appendix D, Support information, on page 41 provides details about: v What information to collect before contacting IBM Support. v The various methods for contacting IBM Support. v How to use IBM Support Assistant. v Instructions and problem-determination resources to isolate and fix the problem yourself. Note: The Community and Support tab on the product information center can provide additional support resources. Statement of Good Security Practices IT system security involves protecting systems and information through prevention, detection and response to improper access from within and outside your enterprise. Improper access can result in information being altered, destroyed, misappropriated or misused or can result in damage to or misuse of your systems, including for use in attacks on others. No IT system or product should be considered completely secure and no single product, service or security measure can be completely effective in preventing improper use or access. IBM systems, products and services are designed to be part of a comprehensive security approach, which will necessarily involve additional operational procedures, and may require other systems, products or services to be most effective. IBM DOES NOT WARRANT THAT ANY SYSTEMS, PRODUCTS OR SERVICES ARE IMMUNE FROM, OR WILL MAKE YOUR ENTERPRISE IMMUNE FROM, THE MALICIOUS OR ILLEGAL CONDUCT OF ANY PARTY. x IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 1. Overview of the adapter Features of the adapter Architecture of the adapter An adapter provides an interface between a managed resource and the IBM Security Identity Manager server. Adapters might reside on the managed resource. The IBM Security Identity Manager server manages access to the resource by using your security system. Adapters function as trusted virtual administrators on the target platform. They perform tasks, such as creating, suspending, and restoring user accounts, and other administrative functions that are performed manually. The adapter runs as a service, independently of whether you are logged on to the IBM Security Identity Manager server. The Microsoft SharePoint Adapter uses the functionality of Tivoli Directory Integrator to enable communication between the IBM Security Identity Manager server and the Microsoft SharePoint server. The adapter automates administrative tasks for the managed resource. The adapter automates the following tasks v Creating users and groups v Modifying SharePoint user attributes and SharePoint groups v Deleting user accounts v Reconciling users and user attributes Microsoft SharePoint Adapter provides a WebService interface that is used to manage those tasks. Microsoft SharePoint Adapter adapters are configured to use the existing WebService, which means that no extra software is required to be deployed on the Microsoft SharePoint Adapter end system. IBM Security Identity Manager communicates with the Microsoft SharePoint Adapter to manager Microsoft SharePoint user accounts. The adapter also supports some group management functions. You can perform the following actions on an account or a group: v Add v Delete v Modify v Search You must install several components for the adapter to function correctly. You must install the following components: v The Dispatcher v The Tivoli Directory Integrator connector v The IBM Security Identity Manager adapter profile Copyright IBM Corp. 2012, 2014 1

You need to install the Dispatcher and the adapter profile; however, the Tivoli Directory Integrator connector might already be installed with the base Tivoli Directory Integrator product. The following figure describes the components that work together to complete the user account management tasks in a Tivoli Directory Integrator environment. IBM Security Identity Manager Server RMI calls Dispatcher Service (an instance of the IBM Tivoli Directory Integrator) Adapter resource Supported configurations Figure 1. The architecture of the Microsoft SharePoint Adapter The Microsoft SharePoint Adapter consists of Tivoli Directory Integrator AssemblyLines. When an initial request is made by IBM Security Identity Manager Server to the adapter, the AssemblyLines are loaded into the IBM Security Identity Manager. As a result, subsequent service requests do not require those same AssemblyLines to be reloaded. The AssemblyLines use the IBM Security Identity Manager SharePoint User connector and RFC functional component to enable user management-related tasks on the Microsoft SharePoint. It does this enablement remotely by using the login ID and password of a user that has administrator privileges. The AssemblyLines also use server information about the location and site of the SharePoint server to perform this task. For more information about Tivoli Directory Integrator, see the Quick Start Guide in the IBM Security Identity Manager product documentation. The adapter supports both single-server and multiple-server configurations. The fundamental components in each environment are: v The IBM Security Identity Manager server v The Tivoli Directory Integrator server v The managed resource v The adapter The adapter must reside directly on the server running the Tivoli Directory Integrator server. Single server configuration In a single server configuration, install the IBM Security Identity Manager server, the Tivoli Directory Integrator server, and the Microsoft SharePoint Adapter on one server to establish communication with the Microsoft SharePoint server. The Microsoft SharePoint server is installed on a different server as described Figure 2 on page 3. 2 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

IBM Security Identity Manager Server Tivoli Directory Integrator Server Managed resource Adapter Figure 2. Example of a single server configuration Multiple server configuration In multiple server configuration, the IBM Security Identity Manager server, the Microsoft SharePoint Adapter, and the Microsoft SharePoint server are installed on different servers. Install the Tivoli Directory Integrator server and the Microsoft SharePoint Adapter on the same server as described Figure 3. IBM Security Identity Manager server Tivoli Directory Integrator server Managed resource Adapter Figure 3. Example of multiple server configuration Chapter 1. Overview of the adapter 3

4 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 2. Adapter installation planning and configuration Preinstallation roadmap Installing and configuring the adapter involves several steps that you must complete in an appropriate sequence. Review the road maps before you begin the installation process. Before you install the adapter, you must prepare the environment. Perform the tasks that are listed in Table 1. Table 1. Preinstallation roadmap Task Obtain the installation software. Verify that your environment meets the software and hardware requirements for the adapter. Obtain and install the Dispatcher. Obtain the necessary information for the installation and configuration. For more information Download the software from Passport Advantage website. See Software download for the SharePoint adapter on page 7. See Prerequisites on page 6. Download the software from Passport Advantage website. See Software download for the SharePoint adapter on page 7. Follow the installation instructions in the dispatcher download package. See Installation worksheet for the adapter on page 7. Installation roadmap To install the adapter, you must complete various sequential tasks. Use the following table to guide you through the installation process. Table 2. Installation roadmap Task For more information Verify the Dispatcher installation. See Dispatcher installation verification on page 9. Install the adapter. See Installing the adapter on page 9. Verify the adapter installation. See Installation verification on page 12. Import the adapter profile. See Importing the adapter profile into the IBM Security Identity Manager server on page 13. Verify the profile installation. See Adapter profile installation verification on page 14. Create an adapter user account. See Adapter user account creation on page 14. Create a service. See Creating a service on page 14. Copyright IBM Corp. 2012, 2014 5

Table 2. Installation roadmap (continued) Task For more information Configure the adapter. See Adapter configuration on page 19. Prerequisites Verify that your environment meets all the prerequisites before you install the adapter. Table 3 identifies the software and operating system prerequisites for the adapter installation. Ensure that you install the adapter on the same workstation as the IBM Tivoli Directory Integrator server. Table 3. Prerequisites to install the adapter Prerequisite Description IBM Tivoli Directory Integrator Version 7.1 fix pack 5 or later IBM Security Identity Manager server Version 6.0 Operating System The Microsoft SharePoint Adapter can be used on any operating system that is supported by Tivoli Directory Integrator. Network Connectivity Internet Protocol network System Administrator authority To complete the adapter installation procedure, you must have system administrator authority. Tivoli Directory Integrator adapters solution directory A Tivoli Directory Integrator adapters solution directory is a Tivoli Directory Integrator work directory for IBM Security Identity Manager adapters. For more information, see the Dispatcher Installation and Configuration Guide. For information about the prerequisites and supported operating systems for Tivoli Directory Integrator, see the IBM Tivoli Directory Integrator 7.1: Administrator Guide. 6 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Installation worksheet for the adapter Use the following table for information that you require before you install the adapter. Table 4. Required information to install the adapter Required information Description Value Tivoli Directory Integrator Home Directory The ITDI_HOME directory contains the jars/connectors subdirectory that contains adapter jars. For example, the jars/connectors subdirectory contains the jar for the UNIX adapter. If Tivoli Directory Integrator is automatically installed with your IBM Security Identity Manager product, the default directory path for Tivoli Directory Integrator is as follows: Windows: v for version 7.1: drive\program Files\IBM\TDI\V7.1 Adapters solution directory When you install the dispatcher, the adapter prompts you to specify a file path for the solution directory. For more information about the solution directory, see the Dispatcher Installation and Configuration Guide. UNIX: v for version 7.1: /opt/ibm/tdi/v7.1 The default solution directory is located at: Windows: v for version 7.1: drive\program Files\IBM\TDI\V7.1\ timsol UNIX: v for version 7.1: /opt/ibm/tdi/v7.1/ timsol Software download for the SharePoint adapter Download the software through your account at the IBM Passport Advantage website. Go to IBM Passport Advantage. See the IBM Security Identity Manager Download Document for instructions. Note: You can also obtain additional adapter information from IBM Support. Chapter 2. Adapter installation planning and configuration 7

8 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 3. Adapter installation All the adapters that are based on the Tivoli Directory Integrator require the Dispatcher for the adapters to function correctly. If the Dispatcher is installed from a previous installation, do not reinstall it unless there is an upgrade to the Dispatcher. See Dispatcher installation verification. After verifying the Dispatcher installation, you might need to install the Tivoli Directory Integrator connector. Depending on your adapter, the connector might already be installed as part of the Tivoli Directory Integrator product and no further action is required. Dispatcher installation verification Installing the adapter If this installation is for the first adapter that is based on the Tivoli Directory Integrator, you must install the Dispatcher before you install the adapter. Install the dispatcher on the same Tivoli Directory Integrator server where you want to install the adapter. Obtain the dispatcher installer from the IBM Passport Advantage website, http://www.ibm.com/software/howtobuy/passportadvantage/ pao_customers.htm. For information about Dispatcher installation, see the Dispatcher Installation and Configuration Guide. Use this procedure to install the adapter software. Before you begin Perform the following tasks: v Verify that your site meets all the prerequisite requirements. See Prerequisites on page 6. v Obtain a copy of the installation software. See Software download for the SharePoint adapter on page 7. v Obtain system administrator authority. See Prerequisites on page 6. You must also perform the following tasks: v Enable Basic Authentication in IIS for the Sharepoint site. See the Configure Basic Authentication (IIS 7) topic on the Microsoft TechNet website. v Check the Sharepoint site configuration for IIS. Set it to Integrated Windows Negotiated (Kerberos). v Obtain a copy of the web services thin client from WebSphere 7.0 (com.ibm.ws.webservices.thinclient_7.0.0.jar). For information about the web services thin client, see the WebSphere Application Server product documentation and search for com.ibm.ws.webservices.thinclient_7.0.0.jar. v Copy the file to ITDI_HOME/jars/3rdparty/IBM/WebSphere on the computer where Tivoli Directory Integrator is installed. If the WebSphere directory does not exist, create it. Copyright IBM Corp. 2012, 2014 9

About this task The adapter uses the Tivoli Directory Integrator SharePoint connector. The connector is not available with the base Tivoli Directory Integrator product. The adapter installation involves the Tivoli Directory Integrator SharePoint connector installation. Before you install the adapter, make sure that the Dispatcher is already installed. See Dispatcher installation verification on page 9. Procedure To install the adapter, perform the following steps: 1. Create a temporary directory on the workstation where you want to install the adapter. 2. Extract the contents of the compressed file in the temporary directory. 3. Install the adapter JAR files. Copy the SharePointConnector.jar file from the adapter package to the ITDI_HOME/jars/connectors directory. 4. Optional: Enable Unicode See the JVM information in the Dispatcher Installation and Configuration Guide. 5. Restart the Dispatcher service. What to do next After you finish the adapter installation, perform the following tasks: v Configure the authentication providers. See Authentication providers configuration. v Verify that the installation completed successfully. See Installation verification on page 12. v Import the adapter profile. See Importing the adapter profile into the IBM Security Identity Manager server on page 13. v Create a user account for the adapter on IBM Security Identity Manager. See Adapter user account creation on page 14. Authentication providers configuration You must configure the adapter with one of the authentication providers that is supported by the SharePoint Web Application. Authentication providers can be AD Domains or a claims provider. The following SharePoint Servers and their corresponding authentication providers are supported: Table 5. Supported SharePoint Servers and corresponding authentication providers Server version Authentication mode Authentication Provider SharePoint 2010 Classic Mode Integrated Windows (AD) SharePoint 2013 Classic Mode Integrated Windows (AD) SharePoint 2013 Claims Based Authentication Integrated Windows (AD), Forms Based Authentication (FBA), Trusted Identity Provider Information about authentication providers is stored in a configuration file, which is in JSON format. The adapter reads this file and reconciles the list of authentication providers as supporting data. 10 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

The configuration file must have a single JSON array only. Each authentication provider is stored as a JSON Object element in the array with the following keys: v DisplayName v NameOfOriginalIssuer v IssuerType v ClaimsValueType v ClaimsType v Prefix Example of a configuration file with information about the authentication providers. Note: White spaces added for readability. [ { "DisplayName" : "Windows Authentication (EXAMPLEDOMAIN)", "NameOfOriginalIssuer" : "EXAMPLEDOMAIN", "IssuerType" : "w", "ClaimsValueType" : ".", "ClaimsType" : "#", "Prefix" : "i:0#.w EXAMPLEDOMAIN" }, { "DisplayName" : "Some Membership Provider", "NameOfOriginalIssuer" : "SomeMembershipProvider", "IssuerType" : "f", "ClaimsValueType" : ".", "ClaimsType" : "#", "Prefix" : "i:0#.f SomeMembershipProvider " }, { "DisplayName" : "Example ACS", "NameOfOriginalIssuer" : "Example ACS", "IssuerType" : "t", "ClaimsValueType" : ".", "ClaimsType" : "5", "Prefix" : "i:05.t Example ACS " } ] The previous example shows different providers for each JSON Object element. Table 6. Authentication providers listed in the example JSON Object element in the previous example Element #1 Element #2 Element #3 Authentication provider Windows Authentication provider Forms-Based Authentication provider that is using a String logon name as Claims Value Trusted Identity Provider that is using email as Claims Value For a full explanation on the valid values for IssuerType, NameOfOriginalIssuer, ClaimsValueType, and ClaimsType, see the Microsoft SharePoint Products and Technologies Protocol Documentation. With the four values, it is then trivial to create the Prefix. If the site runs on a Classic Mode authentication web application, the configuration file typically looks like the following example: Chapter 3. Adapter installation 11

Installation verification [ { "DisplayName" : "EXAMPLEDOMAIN", "NameOfOriginalIssuer" : "", "IssuerType" : "", "ClaimsValueType" : "", "ClaimsType" : "", "Prefix" : "EXAMPLEDOMAIN" } ] Generating the configuration file A Powershell script is provided to assist with generating the configuration file. Run the script on the SharePoint server with administrator privilege in a command prompt: powershell authprovimport.ps1 -WebApplication http://[sharepointserver]:[port] -SaveAs [filename.json] Copy the configuration file to a location on the server that is running the Adapter Dispatcher service. For example, save the file under TDI_HOME\timsol\ SharePointAdapter folder. Create the SharePointAdapter folder if it does not exist. If the adapter is installed correctly, you can verify that the required components exist in the specified directories. If the adapter is installed correctly, these adapter components exist on the Tivoli Directory Integrator server. Table 7. Adapter component Adapter component SharePointConnector.jar com.ibm.ws.webservices.thinclient_7.0.0.jar JSON files containing authentication providers configuration Directory TDI_HOME\jars\connectors TDI_HOME\jars\3rdparty\IBM\Websphere TDI_HOME\timsol\SharePointAdapter If this installation is to upgrade a connector, then send a request from IBM Security Identity Manager. Verify that the version number in the ibmdi.log matches the version of the connector that you installed. The ibmdi.log file is at ITDI_Home\adapter solution directory\logs directory. Start, stop, and restart of the SharePoint adapter service To start, stop, or restart the adapter, you must start, stop, or restart the Dispatcher. The adapter does not exist as an independent service or a process. The adapter is added to the Dispatcher instance, which runs all the adapters that are installed on the same Tivoli Directory Integrator instance. See the topic about starting stopping, and restarting the dispatcher service in the Dispatcher Installation and Configuration Guide. 12 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Importing the adapter profile into the IBM Security Identity Manager server An adapter profile defines the types of resources that the IBM Security Identity Manager server can manage. About this task Use the profile to create an adapter service on IBM Security Identity Manager server and establish communication with the adapter. Before you can add an adapter as a service to the IBM Security Identity Manager server, the server must have an adapter profile. The adapter profile is used to recognize the adapter as a service. The files that are packaged with the adapter include the adapter SharePointProfile.jar file. You can import the adapter profile as a service profile on the server with the Import feature of IBM Security Identity Manager. The SharePointProfile.jar file includes all the files that are required to define the adapter schema, account form, service form, and profile properties. You can extract the files from the JAR file to modify the necessary files and package the JAR file with the updated files. Before you begin to import the adapter profile, verify that the following conditions are met: v The IBM Security Identity Manager server is installed and running. v You have root or Administrator authority on IBM Security Identity Manager. To import the adapter profile, perform the following steps: Procedure 1. Log on to the IBM Security Identity Manager server by using an account that has the authority to perform administrative tasks. 2. In the My Work pane, expand Configure System and click Manage Service Types. 3. On the Manage Service Types page, click Import to display the Import Service Types page. 4. Specify the location of the SharePointProfile.jar file in the Service Definition File field by performing one of the following tasks: v Type the complete location of where the file is stored. v Use Browse to navigate to the file. 5. Click OK. What to do next v v When you import the adapter profile and if you receive an error related to the schema, see the trace.log file for information about the error. The trace.log file location is specified by using the handler.file.filedir property defined in the IBM Security Identity Manager enrolelogging.properties file. The enrolelogging.properties file is installed in the ITIM_HOME\data directory. Restart the IBM Security Identity Manager for the change to take effect. Chapter 3. Adapter installation 13

Adapter profile installation verification After you install the adapter profile, verify that the installation was successful. An unsuccessful installation: v Might cause the adapter to function incorrectly. v Prevents you from creating a service with the adapter profile. To verify that the adapter profile is successfully installed, create a service with the adapter profile. For more information about creating a service, see Creating a service. If you are unable to create a service using the adapter profile or open an account on the service, the adapter profile is not installed correctly. You must import the adapter profile again. Adapter user account creation Creating a service You must create a user account with administrative privileges for the adapter on the managed resource. You must provide the account information when you create a service on IBM Security Identity Manager. For more information about creating a service, see Creating a service. Ensure that the account has sufficient privileges to administer the Microsoft SharePoint users. You must also enable Windows Authentication with Basic Authentication mode for the SharePoint site. After the adapter profile is imported on IBM Security Identity Manager, you must create a service so that IBM Security Identity Manager can communicate with the adapter. About this task To create or change a service, you must use the service form to provide information for the service. Service forms might vary depending on the adapter. Procedure 1. Log on to the IBM Security Identity Manager server by using an account that has the authority to perform administrative tasks. 2. In the My Work pane, click Manage Services and click Create. 3. On the Select the Type of Service page, select SharePoint Service Profile. 4. Click Next to display the adapter service form. 5. Complete the following fields on the service form: On the Adapter Details tab: 14 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Service Name Specify a name that defines the adapter service on the IBM Security Identity Manager server. Note: Do not use forward (/) or backward slashes (\) in the service name. Description Optional: Specify a description that identifies the service for your environment. TDI URI Optional: Specify the URL for the Tivoli Directory Integrator instance. The valid syntax for the URL is rmi://ipaddress:port/itdidispatcher, where ip-address is the Tivoli Directory Integrator host and port is the port number for the Dispatcher. The default URL is rmi://localhost:1099/itdidispatcher For information about changing the port number, see Dispatcher Installation and Configuration Guide. Owner Optional: Specify a IBM Security Identity Manager user as a service owner. Service Prerequisite Optional: Specify a IBM Security Identity Manager service that is prerequisite to this service. On the SharePoint Domain Details tab Sharepoint hostname Specify the host name or IP address of the SharePoint site. Sharepoint port Specify the SharePoint server port number. The default is port 80. Admin Login Specify the administrator user that the adapter uses to connect to the Microsoft SharePoint instance. Admin Password Specify the password for administrator user. Sharepoint site Optional: Specify the trailing URL to the SharePoint site. For the Sharepoint site subsite that has the location http://sharepointhost/subsite, the field entry is subsite. If you leave this field blank, the default value is the top-level Sharepoint site. Enable SSL Specifies whether you want to enable secure communications. The default response is not to enable SSL. Authentication Mode Specify the authentication mode corresponding to your site. Authentication Provider Configuration File The file name that includes the full path to the authentication Chapter 3. Adapter installation 15

provider file. For more information, see Authentication providers configuration on page 10. If the file is stored in the same location as Dispatcher home, for example, TDI_HOME/timsol, you can omit the path and provide only the file name. On the SharePoint Generic Configuration tab These properties are internal properties. They are listed for informational purposes only. Do not change them from the default configuration. Adapter Task This property allows for plug-able tasks to be called. The format is <Label>:<classname>,<Label>:<Classname>. The label must have a matching Adapter Authenticator Adapter Authenticator This property is the plug-able authenticator for the task. The format is <Label>:<classname>,<Label>:<Classname>.. The label must have a matching Task Authenticator. Create Order This property specifies the order in which the tasks are called during a create operation. The format is <Label> <Label>. Delete Order This property specifies the order in which the tasks are called during a delete operation. The format is <Label> <Label>. Update Order This property specifies the order in which the tasks are called during an update operation. The format is <Label> <Label>. Read Order This property specifies the order in which the tasks are called during a read operation. The format is <Label> <Label>. Attributes Passed Down These attributes are the ones that are required during an authentication phase and are passed down to the Task Authenticator during initialization. The format is <Attribute Name> <Attribute Name>. Attribute Mapping This attribute allows for attributes to be overloaded. In some cases attributes must be converted from and to different names in the adapter task. The format is <ISIM Attribute Name> <Task Attribute Name>,<ISIM Attribute Name> <Task Attribute Name>. On the Status and information tab Contains read only information about the adapter and managed resource. These fields are examples. The actual fields vary depending on the type of adapter and how the service form is configured. The adapter must be running to obtain the information. Click Test Connection to populate the fields. Last status update: Date Specifies the most recent date when the Status and information tab was updated. 16 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Last status update: Time Specifies the most recent time of the date when the Status and information tab was updated. Managed resource status Specifies the status of the managed resource that the adapter is connected to. Adapter version Specifies the version of the adapter that the IBM Security Identity Manager service uses to provision request to the managed resource. Profile version Specifies the version of the profile that is installed in the IBM Security Identity Manager server. TDI version Specifies the version of the Tivoli Directory Integrator on which the adapter is deployed. Dispatcher version Specifies the version of the Dispatcher. Installation platform Specifies summary information about the operating system where the adapter is installed. Adapter account Specifies the account that running the adapter binary file. Adapter up time: Date Specifies the date when the adapter started. Adapter up time: Time Specifies the time of the date when the adapter started. Adapter memory usage Specifies the memory usage for running the adapter. If the connection fails, follow the instructions in the error message. Also v Verify the adapter log to ensure that the IBM Security Identity Manager test request was successfully sent to the adapter. v Verify the adapter configuration information. v Verify IBM Security Identity Manager service parameters for the adapter profile, such as the work station name or the IP address of the managed resource and the port. 6. Click Finish. Chapter 3. Adapter installation 17

18 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 4. First steps after installation Adapter configuration After you install the adapter, you must do several other tasks. The tasks include configuring the adapter, setting up SSL, installing the language pack, and verifying that the adapter works correctly. Use the following options to configure the Microsoft SharePoint Adapter. v Editing adapter profiles on the UNIX or Linux operating system v Creating a JAR file and importing the profile on the IBM Security Identity Manager on page 20 See the Dispatcher Installation and Configuration Guide for additional configuration options such as: v JVM properties v Dispatcher filtering v Dispatcher properties v Dispatcher port number v Logging configurations v Secure Sockets Layer (SSL) communication Editing adapter profiles on the UNIX or Linux operating system The adapter profile.jar file might contain ASCII files that are created by using the MS-DOS ASCII format. About this task If you edit an MS-DOS ASCII file on the UNIX operating system, you might see a character ^M at the end of each line. These characters indicate new lines of text in MS-DOS. The characters can interfere with the running of the file on UNIX or Linux systems. You can use tools, such as dos2unix, to remove the ^M characters. You can also use text editors, such as the vi editor, to remove the characters manually. Example You can use the vi editor to remove the ^M characters. From the vi command mode, run the following command and press Enter: :%s/^m//g When you use this command, enter ^M or Ctrl-M by pressing ^v^m or Ctrl V Ctrl M sequentially. The ^v instructs the vi editor to use the next keystroke instead of issuing it as command. Copyright IBM Corp. 2012, 2014 19

Creating a JAR file and importing the profile on the IBM Security Identity Manager After you modify the schema.dsml or any other profile files, you must import these files into IBM Security Identity Manager for the changes to take effect. About this task In order to install the new attributes, complete the following steps: Note: If you are upgrading an existing adapter profile, the new adapter profile schema is not reflected immediately. You must stop and start the IBM Security Identity Manager server to refresh the cache and the adapter schema. For more information about upgrading an existing adapter, see Chapter 6, Adapter upgrade, on page 27. Procedure 1. Extract the contents of the SharePointProfile.jar file into the temporary directory by running the following command: cd c:\temp jar -xvf SharePointProfile.jar The jar command creates the c:\temp\sharepointprofile directory. 2. Update the profile files. 3. Create a JAR file using the files in the \temp directory by running the following commands: cd c:\temp jar -cvf SharePointProfile.jar SharePointProfile 4. Import the SharePointProfile.jar file into the IBM Security Identity Manager server. For more information about importing the file, see Importing the adapter profile into the IBM Security Identity Manager server on page 13. 5. Stop and start the IBM Security Identity Manager server. Language pack installation for the SharePoint adapter The adapters use a separate language package from the IBM Security Identity Manager. See the IBM Security Identity Manager library and search for information about installing the adapter language pack. Verification that the SharePoint adapter is working correctly After you install and configure the adapter, take steps to verify that the installation and configuration are correct. Procedure 1. Test the connection for the service that you created on IBM Security Identity Manager. 2. Run a full reconciliation from IBM Security Identity Manager. 3. Run all supported operations such as add, modify, and delete on one user account. 4. Verify the ibmdi.log file after each operation to ensure that no errors are reported. 20 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

5. Verify the IBM Security Identity Manager log file trace.log to ensure that no errors are reported when you run an adapter operation. Chapter 4. First steps after installation 21

22 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 5. Troubleshooting the adapter errors Troubleshooting can help you determine why a product does not function properly. These topics provide information and techniques for identifying and resolving problems with the adapter. It also provides information about troubleshooting errors that might occur during the adapter installation. Techniques for troubleshooting problems Troubleshooting is a systematic approach to solving a problem. The goal of troubleshooting is to determine why something does not work as expected and how to resolve the problem. Certain common techniques can help with the task of troubleshooting. The first step in the troubleshooting process is to describe the problem completely. Problem descriptions help you and the IBM technical-support representative know where to start to find the cause of the problem. This step includes asking yourself basic questions: v What are the symptoms of the problem? v Where does the problem occur? v When does the problem occur? v Under which conditions does the problem occur? v Can the problem be reproduced? The answers to these questions typically lead to a good description of the problem, which can then lead you to a problem resolution. What are the symptoms of the problem? When starting to describe a problem, the most obvious question is What is the problem? This question might seem straightforward; however, you can break it down into several more-focused questions that create a more descriptive picture of the problem. These questions can include: v Who, or what, is reporting the problem? v What are the error codes and messages? v How does the system fail? For example, is it a loop, hang, crash, performance degradation, or incorrect result? Where does the problem occur? Determining where the problem originates is not always easy, but it is one of the most important steps in resolving a problem. Many layers of technology can exist between the reporting and failing components. Networks, disks, and drivers are only a few of the components to consider when you are investigating problems. The following questions help you to focus on where the problem occurs to isolate the problem layer: v v Is the problem specific to one platform or operating system, or is it common across multiple platforms or operating systems? Is the current environment and configuration supported? Copyright IBM Corp. 2012, 2014 23

v v Do all users have the problem? (For multi-site installations.) Do all sites have the problem? If one layer reports the problem, the problem does not necessarily originate in that layer. Part of identifying where a problem originates is understanding the environment in which it exists. Take some time to completely describe the problem environment, including the operating system and version, all corresponding software and versions, and hardware information. Confirm that you are running within an environment that is a supported configuration; many problems can be traced back to incompatible levels of software that are not intended to run together or have not been fully tested together. When does the problem occur? Develop a detailed timeline of events leading up to a failure, especially for those cases that are one-time occurrences. You can most easily develop a timeline by working backward: Start at the time an error was reported (as precisely as possible, even down to the millisecond), and work backward through the available logs and information. Typically, you need to look only as far as the first suspicious event that you find in a diagnostic log. To develop a detailed timeline of events, answer these questions: v Does the problem happen only at a certain time of day or night? v How often does the problem happen? v What sequence of events leads up to the time that the problem is reported? v Does the problem happen after an environment change, such as upgrading or installing software or hardware? Responding to these types of questions can give you a frame of reference in which to investigate the problem. Under which conditions does the problem occur? Knowing which systems and applications are running at the time that a problem occurs is an important part of troubleshooting. These questions about your environment can help you to identify the root cause of the problem: v Does the problem always occur when the same task is being performed? v Does a certain sequence of events need to happen for the problem to occur? v Do any other applications fail at the same time? Answering these types of questions can help you explain the environment in which the problem occurs and correlate any dependencies. Remember that just because multiple problems might have occurred around the same time, the problems are not necessarily related. Can the problem be reproduced? From a troubleshooting standpoint, the ideal problem is one that can be reproduced. Typically, when a problem can be reproduced you have a larger set of tools or procedures at your disposal to help you investigate. Consequently, problems that you can reproduce are often easier to debug and solve. However, problems that you can reproduce can have a disadvantage: If the problem is of significant business impact, you do not want it to recur. If possible, 24 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

re-create the problem in a test or development environment, which typically offers you more flexibility and control during your investigation. v Can the problem be re-created on a test system? v Are multiple users or applications encountering the same type of problem? v Can the problem be re-created by running a single command, a set of commands, or a particular application? For information about obtaining support, see Appendix D, Support information, on page 41. Chapter 5. Troubleshooting the adapter errors 25

26 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 6. Adapter upgrade Connector upgrade Profile upgrade The adapter is upgraded by installing the new version of the adapter. Upgrading the adapter might also involve tasks, such as upgrading the connector, the dispatcher, and the existing adapter profile. To verify the required version of these adapter components, see the adapter release notes. For the installation steps, see Chapter 3, Adapter installation, on page 9. Before you upgrade the connector, verify the version of the connector. v If the connector version mentioned in the release notes is later than the existing version on your workstation, install the connector. v If the connector version mentioned in the release notes is the same or earlier than the existing version, do not install the connector. Note: Stop the dispatcher service before the upgrading the connector and start it again after the upgrade is complete. Read the adapter Release Notes for any specific instructions before you import a new adapter profile into IBM Security Identity Manager. See Importing the adapter profile into the IBM Security Identity Manager server on page 13. Note: Restart the dispatcher service after importing the profile. Restarting the dispatcher clears the assembly lines cache and ensures that the dispatcher executes the assembly lines from the updated adapter profile. Copyright IBM Corp. 2012, 2014 27

28 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 7. Adapter uninstallation To completely uninstall the Microsoft SharePoint Adapter, you must do these procedures: 1. Uninstall the adapter from Tivoli Directory Integrator server. 2. Remove the adapter profile from the IBM Security Identity Manager server. Uninstalling the adapter from the Tivoli Directory Integrator server The Microsoft SharePoint Adapter installation process also installs the Tivoli Directory Integrator SharePoint connector. About this task To remove the Microsoft SharePoint Adapter, complete these steps: Procedure 1. Stop the adapter service. 2. Remove the SharePointConnector.jar file from the ITDI_HOME/jars/connectors directory. 3. Start the service. Adapter profile removal from the IBM Security Identity Manager server Before you remove the adapter profile, ensure that no objects exist on your IBM Security Identity Manager server that reference the adapter profile. Examples of objects on theibm Security Identity Manager server that can reference the adapter profile are: v Adapter service instances v Policies referencing an adapter instance or the profile v Accounts Note: The Dispatcher component must be installed on your system for adapters to function correctly in a Tivoli Directory Integrator environment. When you delete the adapter profile for the Microsoft SharePoint Adapter, do not uninstall the Dispatcher. For specific information about how to remove the adapter profile, see the online help or the IBM Security Identity Manager product documentation. Copyright IBM Corp. 2012, 2014 29

30 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Chapter 8. Adapter reinstallation There are no special considerations for reinstalling the adapter. You are not required to remove the adapter before reinstalling. See Chapter 6, Adapter upgrade, on page 27. Copyright IBM Corp. 2012, 2014 31

32 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Appendix A. Adapter usage screens Group creation Each screen has different fields. The following topics describe the fields and some of their limitations. The following table lists the required fields that are used to create a group. Table 8. Required group creation fields Title Group Name Group Description Group Owner Type Group Owner ID Group Default User Description The name of the group. A description for the group. User or Group. The Group Owner ID must be either a user or group based on this selection. If the user is selected in the Group Owner Type field, the full domain qualified user ID or Claims ID must be specified. If the group is selected, it must be a group that exists in Sharepoint. Note: To obtain the full Claims ID, append the Claims Prefix, which is stored as erspdomain in the account object, with the Claims Value, which is stored as eruid in the account object. If it is a Windows Authentication claim, add a backslash (\) after the domain name. A full domain qualified user ID. The user must exist in the backing store. If no user is specified then the administration user that is used in the configuration of the profile is set in this field. Group reconciliation Group modification Group deletion No specific screens exist for a reconciliation. The reconciliation operation does not return the Group Default User. During a modify operation, the parameters are changed if you specify the Group Default User. If you do not specify the Group Default User, no changes are made. No specific screens exist for deleting a group. If a group is deleted, any users mapped to the group are removed from the mapping. The users are not removed from Microsoft SharePoint. Copyright IBM Corp. 2012, 2014 33

User creation When you create a user in Microsoft SharePoint through IBM Security Identity Manager, you must specify certain attributes. These attributes must be specified when you create a user. Table 9. Required attributes for creating a user Attribute Description User ID This attribute is the SharePoint user backing store account name without the domain or claims prefix. For Example: Administrator. This user must be exist on the backing store. User Name The user display name for SharePoint. User Email An email address for SharePoint to send notifications and alerts to this user. Domain The domain or claims provider that this user ID belongs to. Groups Selection of the groups. User reconciliation User modification Note: The User Notes attribute is deprecated. It is removed from the account form. However, the attribute is maintained in the schema for backwards-compatibility reason. No specific screens exist for a user reconciliation. The same user ID in different domains or claims providers is not supported for a reconciliation. For example, the Administrator ID is returned from one location only. During a modify operation, the screen contains the same attributes that are listed when you create a user. Modifying a field changes the SharePoint user. Do not change the UserID or the Domain field. Changing either of these attributes causes the modification to fail. User deletion No specific screens exist for deleting a user. The user is removed from any groups to which the user belongs. If the user is the last member of the group, the group is not deleted. You must use the remove group command to delete a group. 34 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Appendix B. Adapter attributes Attribute descriptions An adapter provides an interface between a managed resource and the IBM Security Identity Manager server. As part of the adapter implementation, a dedicated account for IBM Security Identity Manager to access the Microsoft SharePoint is created on the Microsoft SharePoint. The adapter consists of files and directories that are owned by the IBM Security Identity Manager account. These files establish communication with the IBM Security Identity Manager server. The IBM Security Identity Manager server communicates with the Microsoft SharePoint Adapter using attributes that are included in transmission packets that are sent over a network. After you install the adapter profile, the Microsoft SharePoint Adapter supports a standard set of attributes. The following tables list the standard attributes and object classes supported by the adapter. The combination of attributes depends on the type of action that the IBM Security Identity Manager server requests from the Microsoft SharePoint Adapter. Standard attributes The following table lists the attributes that are used by the Microsoft SharePoint Adapter. The table gives a brief description and corresponding values of the attribute. Table 10. Supported attributes IBM Security Identity Manager Name Attribute Name Description Data type SharePoint Hostname ersphostname The host name of the Sharepoint server URL of TDI eritdiurl The URL of the TDI dispatcher Description description Description field for the adapter SharePoint port erspport The port that Sharepoint is listening to Administrator Account Administrator Password erspadminaccount erservicepwd1 The administration account used to update Sharepoint The password for the administration account Authentication Mode erspsiteauthtype The authentication mode for the corresponding SharePoint server version String String String String String Password String Copyright IBM Corp. 2012, 2014 35

Table 10. Supported attributes (continued) IBM Security Identity Manager Name Attribute Name Description Data type Authentication Provider Configuration File erspsiteauthprovfilepath The file path to the authentication provider configuration file Site URL erspsiteurl A specific site on the Sharepoint host that is not the root site Enable SSL erspenablessl If this attribute is enabled, then HTTPS is used instead of HTTP Adapter Name erspadapter This attribute is used to load the Sharepoint adapter. Adapter Authentication erspadapterauthn This attribute is used to load the Sharepoint adapter authentication module. Create Order erspadaptercreateorder Describes the order in which adapters are called Delete Order erspadapterdeleteorder Describes the order in which adapters are called Update Order erspadapterupdateorder Describes the order in which adapters are called Read Order erspadapterreadorder Describes the order in which adapters are called Attribute Mapping erspadapterattributemap This attribute is used to map common IBM Security Identity Manager attributes to adapter-specific attributes. Configuration Attributes erspconfigurationattributes This list the adapter-specific configuration attributes that are passed by the service.def User ID eruid The Sharepoint user ID. Typically, the login name or claims value User Name erspusername The user display name for the Sharepoint user User Email erspemail The email address for the Sharepoint user String String String String String String String String String String String String String String 36 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Table 10. Supported attributes (continued) IBM Security Identity Manager Name Attribute Name Description Data type User Notes erspusernotes Notes about the Sharepoint user. Note: This field is deprecated. It is kept in the schema for backwards-compatibility purpose only. String Domain erspdomain The domain name or claims prefix for the Sharepoint Group List erspgrouplist The list of groups that this user is part of in Sharepoint String String Group Name erspgroupname The name of the group String in Sharepoint Group Owner ID erspgroupownerid The owning ID of the String group Group Owner Type erspgroupownertype The type of the owner String Group Default User erspgroupdefaultuser The default user of for String the group Group Description erspgroupdescription A description for the group String Authentication Provider Name Authentication Provider Prefix erspauthprovname erspauthprovprefix The display name for the authentication provider The prefix for the authentication provider. If it is for the Classic Mode Authentication site, then this is the domain name. If it is for the Claims-Based Authentication site, then this is the claims prefix String String Claims Type erspauthclaimstype The claim type encoding String Claims Value Type erspauthclaimsvaluetype The claims value type, normally a period (.) to indicate string String Authentication Issuer Type Original Issuer Name erspauthissuertype erspauthoriginalissuer The issuer type of the claims provider The original issuer name of the claims provider String String Supported object classes The following table lists the object classes that are used by the Microsoft SharePoint Adapter. The table gives a brief description and corresponding values of the object class. Appendix B. Adapter attributes 37

Table 11. Supported object classes Description Object class name in schema Superior Account class erspaccount top Service class erspservice top Group class erspgroupaccount top Authentication Provider class erspauthenticationprovider top Adapter configuration properties For information about setting Tivoli Directory Integrator configuration properties for the operation of the Microsoft SharePoint Adapter, see the Dispatcher Installation and Configuration Guide. 38 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Appendix C. Definitions for ITDI_HOME and ISIM_HOME directories ITDI_HOME is the directory where Tivoli Directory Integrator is installed. ISIM_HOME is the directory where IBM Security Identity Manager is installed. ITDI_HOME This directory contains the jars/connectors subdirectory that contains files for the adapters. Windows drive\program Files\IBM\TDI\ITDI_VERSION For example the path for version 7.1: C:\Program Files\IBM\TDI\V7.1 UNIX /opt/ibm/tdi/itdi_version For example the path for version 7.1: /opt/ibm/tdi/v7.1 ISIM_HOME This directory is the base directory that contains the IBM Security Identity Manager code, configuration, and documentation. Windows path\ibm\isim UNIX path/ibm/isim Copyright IBM Corp. 2012, 2014 39

40 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Appendix D. Support information Searching knowledge bases You have several options to obtain support for IBM products. v Searching knowledge bases v Obtaining a product fix on page 42 v Contacting IBM Support on page 42 You can often find solutions to problems by searching IBM knowledge bases. You can optimize your results by using available resources, support tools, and search methods. About this task You can find useful information by searching the product documentation for IBM Security Identity Manager. However, sometimes you must look beyond the product documentation to answer your questions or resolve problems. Procedure To search knowledge bases for information that you need, use one or more of the following approaches: 1. Search for content by using the IBM Support Assistant (ISA). ISA is a no-charge software serviceability workbench that helps you answer questions and resolve problems with IBM software products. You can find instructions for downloading and installing ISA on the ISA website. 2. Find the content that you need by using the IBM Support Portal. The IBM Support Portal is a unified, centralized view of all technical support tools and information for all IBM systems, software, and services. The IBM Support Portal lets you access the IBM electronic support portfolio from one place. You can tailor the pages to focus on the information and resources that you need for problem prevention and faster problem resolution. Familiarize yourself with the IBM Support Portal by viewing the demo videos (https://www.ibm.com/blogs/spna/entry/the_ibm_support_portal_videos) about this tool. These videos introduce you to the IBM Support Portal, explore troubleshooting and other resources, and demonstrate how you can tailor the page by moving, adding, and deleting portlets. 3. Search for content about IBM Security Identity Manager by using one of the following additional technical resources: v IBM Security Identity Manager version 6.0 technotes and APARs (problem reports). v IBM Security Identity Manager Support website. v IBM Redbooks. v IBM support communities (forums and newsgroups). 4. Search for content by using the IBM masthead search. You can use the IBM masthead search by typing your search string into the Search field at the top of any ibm.com page. 5. Search for content by using any external search engine, such as Google, Yahoo, or Bing. If you use an external search engine, your results are more likely to Copyright IBM Corp. 2012, 2014 41

Obtaining a product fix include information that is outside the ibm.com domain. However, sometimes you can find useful problem-solving information about IBM products in newsgroups, forums, and blogs that are not on ibm.com. Tip: Include IBM and the name of the product in your search if you are looking for information about an IBM product. A product fix might be available to resolve your problem. About this task Contacting IBM Support You can get fixes by following these steps: Procedure 1. Obtain the tools that are required to get the fix. You can obtain product fixes from the Fix Central Site. See http://www.ibm.com/support/fixcentral/. 2. Determine which fix you need. 3. Download the fix. Open the download document and follow the link in the Download package section. 4. Apply the fix. Follow the instructions in the Installation Instructions section of the download document. IBM Support assists you with product defects, answers FAQs, and helps users resolve problems with the product. Before you begin After trying to find your answer or solution by using other self-help options such as technotes, you can contact IBM Support. Before contacting IBM Support, your company or organization must have an active IBM software subscription and support contract, and you must be authorized to submit problems to IBM. For information about the types of available support, see the Support portfolio topic in the Software Support Handbook. Procedure To contact IBM Support about a problem: 1. Define the problem, gather background information, and determine the severity of the problem. For more information, see the Getting IBM support topic in the Software Support Handbook. 2. Gather diagnostic information. 3. Submit the problem to IBM Support in one of the following ways: v Using IBM Support Assistant (ISA): Any data that has been collected can be attached to the service request. Using ISA in this way can expedite the analysis and reduce the time to resolution. a. Download and install the ISA tool from the ISA website. See http://www.ibm.com/software/support/isa/. b. Open ISA. 42 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

v v c. Click Collection and Send Data. d. Click the Service Requests tab. e. Click Open a New Service Request. Online through the IBM Support Portal: You can open, update, and view all of your service requests from the Service Request portlet on the Service Request page. By telephone for critical, system down, or severity 1 issues: For the telephone number to call in your region, see the Directory of worldwide contacts web page. Results If the problem that you submit is for a software defect or for missing or inaccurate documentation, IBM Support creates an Authorized Program Analysis Report (APAR). The APAR describes the problem in detail. Whenever possible, IBM Support provides a workaround that you can implement until the APAR is resolved and a fix is delivered. IBM publishes resolved APARs on the IBM Support website daily, so that other users who experience the same problem can benefit from the same resolution. Appendix D. Support information 43

44 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Appendix E. Accessibility features for IBM Security Identity Manager Accessibility features help users who have a disability, such as restricted mobility or limited vision, to use information technology products successfully. Accessibility features The following list includes the major accessibility features in IBM Security Identity Manager. v Support for the Freedom Scientific JAWS screen reader application v Keyboard-only operation v Interfaces that are commonly used by screen readers v Keys that are discernible by touch but do not activate just by touching them v Industry-standard devices for ports and connectors v The attachment of alternative input and output devices The IBM Security Identity Manager library, and its related publications, are accessible. Keyboard navigation This product uses standard Microsoft Windows navigation keys. Related accessibility information The following keyboard navigation and accessibility features are available in the form designer: v v v v You can use the tab keys and arrow keys to move between the user interface controls. You can use the Home, End, Page Up, and Page Down keys for more navigation. You can launch any applet, such as the form designer applet, in a separate window to enable the Alt+Tab keystroke to toggle between that applet and the web interface, and also to use more screen workspace. To launch the window, click Launch as a separate window. You can change the appearance of applets such as the form designer by using themes, which provide high contrast color schemes that help users with vision impairments to differentiate between controls. IBM and accessibility See the IBM Human Ability and Accessibility Center For more information about the commitment that IBM has to accessibility. Copyright IBM Corp. 2012, 2014 45

46 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Notices This information was developed for products and services offered in the U.S.A. IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-ibm product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to: IBM Director of Licensing IBM Corporation North Castle Drive Armonk, NY 10504-1785 U.S.A. For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to: Intellectual Property Licensing Legal and Intellectual Property Law IBM Japan, Ltd. 19-21, Nihonbashi-Hakozakicho, Chuo-ku Tokyo 103-8510, Japan The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law : INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement might not apply to you. This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice. Any references in this information to non-ibm Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk. Copyright IBM Corp. 2012, 2014 47

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you. Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact: IBM Corporation 2Z4A/101 11400 Burnet Road Austin, TX 78758 U.S.A. Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee. The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us. Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment. Information concerning non-ibm products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-ibm products. Questions on the capabilities of non-ibm products should be addressed to the suppliers of those products. All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only. This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. COPYRIGHT LICENSE: This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs. You may copy, modify, and distribute these sample programs in any form without payment to 48 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

IBM for the purposes of developing, using, marketing, or distributing application programs conforming to IBM's application programming interfaces. Each copy or any portion of these sample programs or any derivative work, must include a copyright notice as follows: If you are viewing this information softcopy, the photographs and color illustrations might not appear. (your company name) (year). Portions of this code are derived from IBM Corp. Sample Programs. Copyright IBM Corp. _enter the year or years_. All rights reserved. If you are viewing this information in softcopy form, the photographs and color illustrations might not be displayed. Trademarks IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml. Adobe, Acrobat, PostScript and all Adobe-based trademarks are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States, other countries, or both. IT Infrastructure Library is a registered trademark of the Central Computer and Telecommunications Agency which is now part of the Office of Government Commerce. Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. ITIL is a registered trademark, and a registered community trademark of the Office of Government Commerce, and is registered in the U.S. Patent and Trademark Office. UNIX is a registered trademark of The Open Group in the United States and other countries. Cell Broadband Engine and Cell/B.E. are trademarks of Sony Computer Entertainment, Inc., in the United States, other countries, or both and is used under license therefrom. Notices 49

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates. Privacy Policy Considerations IBM Software products, including software as a service solutions, ("Software Offerings") may use cookies or other technologies to collect product usage information, to help improve the end user experience, and to tailor interactions with the end user or for other purposes. In many cases, no personally identifiable information is collected by the Software Offerings. Some of our Software Offerings can help enable you to collect personally identifiable information. If this Software Offering uses cookies to collect personally identifiable information, specific information about this offering s use of cookies is set forth below. This Software Offering does not use cookies or other technologies to collect personally identifiable information. If the configurations deployed for this Software Offering provide you as customer the ability to collect personally identifiable information from end users via cookies and other technologies, you should seek your own legal advice about any laws applicable to such data collection, including any requirements for notice and consent. For more information about the use of various technologies, including cookies, for these purposes, see IBM's Privacy Policy at http://www.ibm.com/privacy and IBM s Online Privacy Statement at http://www.ibm.com/privacy/details/us/en sections entitled "Cookies, Web Beacons and Other Technologies and Software Products and Software-as-a Service". 50 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Index A accessibility x, 45 adapter administrative task automation 1 architecture AssemblyLines 1 directory integrator connector 1 dispatcher 1 profile 1 attribute descriptions 35 communication between resource, server 35 configuration 19 dedicated account 35 features 1 fields creating a group 33 creating a user 34 deleting a group 33 deleting a user 34 modifying a group 33 modifying a user 34 reconciling a group 33 reconciling a user 34 installation Dispatcher requirement 9 tasks 9 troubleshooting errors 23 verifying 12, 20 warnings 23 worksheet 7 object class descriptions 35 overview 1 post-installation steps 19 supported configurations 2 trusted virtual administrator 1 uninstall 29 upgrading 27 user account creation 14 adapter profile account creation 14 importing 13, 20 JAR file, creating 20 removing 29 schema.dsml 20 service creation 14 upgrading 13, 27 verifying 14 administrative task automation SharePoint user attribute modification, group modification 1 user account deletion 1 attribute reconciliation 1 group creation 1 AssemblyLines 1 attributes descriptions 35 standard 35 C configuration, adapter 19 connector, upgrading 27 D directory integrator connector 1 dispatcher adapter architecture 1 installation, verifying 9 download, software 7 E education x F fields creating a group 33 creating a user 34 deleting a group 33 deleting a user 34 modifying a group 33 modifying a user 34 reconciling a group 33 reconciling a user 34 G group, fields required to create 33 I IBM Software Support x Support Assistant x IBM Support Assistant 42 installation adapter Dispatcher requirement 9 profile 13 software 9 first post-installation steps 19 language pack 20 roadmap 5 uninstall 29 verification adapter 20 verify 12 verify dispatcher 9 worksheet 7 ISA 42 ISIM_HOME definition 39 ITDI_HOME definition 39 K knowledge bases 41 L language pack installation 20 same for adapters and server 20 M MS-DOS ASCII characters 19 N notices 47 O object classes descriptions 35 supported 35 online publications ix terminology ix operating system prerequisites 6 supported by Tivoli Directory Integrator 6 P preinstallation roadmap 5 problem-determination x profile editing on UNIX or Linux 19 importing 13 publications accessing online ix list of ix R removing adapter profiles 29 roadmaps installation 5 preinstallation 5 S screen fields creating a group 33 creating a user 34 deleting a group 33 deleting a user 34 modifying a group 33 modifying a user 34 Copyright IBM Corp. 2012, 2014 51

screen fields (continued) reconciling a group 33 reconciling a user 34 service communication with adapter 14 creating 14 restart 12 start 12 stop 12 software download 7 requirements 6 website 7 support contact information 42 supported configurations adapter 2 overview 2 T task automation SharePoint user attribute modification, group modification 1 user account deletion 1 attribute reconciliation 1 group creation 1 terminology ix training x troubleshooting contacting support 42 getting fixes 42 identifying problems 23 searching knowledge bases 41 support website x techniques 23 U uninstallation 29 upgrade adapter 27 adapter profile 27 connectors 27 user account creation 14 attributes for creation 34 V verification installation 20 operating system prerequisites 6 requirements 6 software prerequisites 6 requirements 6 vi command 19 52 IBM Security Identity Manager: Microsoft SharePoint Adapter Installation and Configuration Guide

Printed in USA SC27-4416-04