Connector Guide for Generic REST - Oracle

Oracle? Identity Manager

Connector Guide for Generic REST

Release 11.1.1

E71482-09 September 2020

Oracle Identity Manager Connector Guide for Generic REST, Release 11.1.1

E71482-09

Copyright ? 2016, 2020, Oracle and/or its affiliates.

Primary Author: Gowri.G.R

Contributing Authors: Alankrita Prakash

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Contents

Preface

Audience

viii

Documentation Accessibility

viii

Related Documents

viii

Conventions

viii

What's New in Oracle Identity Manager Connector for Generic REST?

Software Updates

x

Documentation-Specific Updates

x

1 About the Generic REST Connector

1.1 Introduction to the Generic REST Connector

1-1

1.2 Certified Components for the Generic REST Connector

1-2

1.3 Certified Languages for the Generic REST Connector

1-3

1.4 Features of the Generic REST Connector

1-3

1.4.1 Support for Both Trusted Source and Target Resource Reconciliation

1-3

1.4.2 Full and Incremental Reconciliation

1-3

1.4.3 Limited (Filtered) Reconciliation

1-4

1.4.4 Custom Authentication

1-4

1.4.5 Custom Parsing

1-4

1.4.6 Custom Payload

1-4

1.4.7 Support for Additional HTTP Headers

1-4

1.4.8 Support for Handling Multiple Endpoint URLs

1-5

1.4.9 SSL Communication

1-5

1.5 Use Cases Supported by the Generic REST Connector

1-5

1.6 Architecture of the Generic REST Connector

1-6

1.7 Generic REST Connector Concepts

1-8

iii

2 Prerequisites for Installing the Generic REST Connector

2.1 Downloading the Connector Installation Package

2.2 Creating a Schema File

2.3 Updating the Groovy File

2.3.1 About the dateAttributeList, entitlementAttributeList, lookupAttributeList, and alias Entries of the Groovy File

2-1 2-1 2-5

2-10

3 Installing the Generic REST Connector

3.1 Installing the Connector Installation Package

3-1

3.2 Generating and Installing the Connector Metadata Package

3-2

3.2.1 Running the Metadata Generator

3-2

3.2.2 Installing the Connector Metadata Package

3-3

3.2.3 Understanding the Generated Connector Metadata Package for the

Generic REST Connector

3-4

4 Configuring the Generic REST Connector

4.1 Configuring the IT Resource for the Target System 4.1.1 Specifying Values for the IT Resource Parameters 4.1.2 Connection Parameters 4.1.3 Authentication Parameters 4.1.4 Parser Parameters 4.1.5 Additional Configuration Parameters

4.2 Performing Postinstallation Tasks 4.2.1 Configuring Oracle Identity Manager 4.2.1.1 Creating and Activating a Sandbox 4.2.1.2 Creating a New UI Form 4.2.1.3 Associating the Form with the Application Instance 4.2.1.4 Publishing a Sandbox 4.2.1.5 Harvesting Entitlements and Sync Catalog 4.2.2 Managing Logging for the Generic REST Connector 4.2.2.1 Understanding Log Levels 4.2.2.2 Enabling Logging 4.2.3 Configuring SSL 4.2.4 Localizing Field Labels in UI Forms 4.2.5 Clearing Content Related to Connector Resource Bundles from the Server Cache

4-1 4-1 4-2 4-3 4-6 4-7 4-13 4-14 4-14 4-14 4-15 4-15 4-15 4-16 4-16 4-17 4-18 4-19

4-21

5 Using the Generic REST Connector

5.1 Configuring Reconciliation

5-1

iv

5.1.1 Reconciliation Rules for the Generic REST Connector

5-1

5.1.2 Full Reconciliation and Incremental Reconciliation

5-2

5.1.3 Updating the User Reconciliation Scheduled Job for Incremental

Reconciliation

5-2

5.1.4 Limited (Filtered) Reconciliation

5-3

5.1.5 Lookup Field Synchronization

5-3

5.1.6 Reconciling Large Number of Records

5-4

5.2 Scheduled Jobs

5-4

5.2.1 Scheduled Job for Lookup Field Synchronization

5-5

5.2.2 Scheduled Jobs for Reconciliation of User Records

5-5

5.2.3 Configuring Scheduled Jobs

5-6

5.3 Performing Provisioning Operations

5-8

5.4 Uninstalling the Connector

5-8

6 Extending the Functionality of the Generic REST Connector

6.1 Implementing Custom Authentication 6.2 Implementing Custom Parsing 6.3 Adding Custom OIM User Fields for Trusted Source Reconciliation 6.4 Adding Custom Fields for Target Resource Reconciliation 6.5 Adding Custom Fields for Provisioning 6.6 Configuring Transformation of Data During User Reconciliation 6.7 Configuring Validation of Data During Reconciliation and Provisioning

6-1 6-3 6-5 6-7 6-9 6-11 6-13

7 Frequently Asked Questions for the Generic REST Connector

A Sample Schema File

B Lookup Definitions Used During Connector Operations

B.1 Predefined Lookup Definitions

B-1

B.1.1 Lookup.RESOURCE.Configuration

B-1

B.1.2 Lookup.RESOURCE.UM.Configuration

B-2

B.1.3 Lookup.RESOURCE.UM.ReconAttrMap

B-2

B.1.4 Lookup.RESOURCE.UM.ProvAttrMap

B-3

B.1.5 Lookup.RESOURCE.UM.ReconAttrMap.Defaults

B-4

B.2 Lookup Definitions Synchronized with the Target System

B-5

v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download