IBM ^® Security Verify Governance Adapter 10.0.6 for ServiceNow - Release Notes 

IBM Security Verify Governance Adapter for ServiceNow 10.0.6 is available. Compatibility, installation, and other getting-started issues are addressed.

Copyright International Business Machines Corporation 2023. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

Table of Contents

Preface

Welcome to the IBM Security Verify Governance ServiceNow Adapter.

These Release Notes contain information for the following products that was not available when the IBM Security Verify Governance Adapter manuals were printed:

• IBM Security Verify Governance ServiceNow Adapter Installation and Configuration Guide

Adapter Features and Purpose

The ServiceNow Adapter is designed to create and manage accounts on ServiceNow portal. The adapter runs in "agentless" mode. The adapter uses the REST API to establish communication with the ServiceNow server.

The Verify Governance adapters are powerful tools that require Administrator Level authority. Adapters operate much like a human system administrator, creating accounts, permissions and home directories Operations requested from the IBM Security Verify Governance or Identity Manager server will fail if the adapter is not given sufficient authority to perform the requested task.

License Agreement

Review and agree to the terms of the IBM Security Verify Governance Adapters License prior to using this product. The license can be viewed from the "license" folder included in the product package.

Contents of this Release

Adapter Version

New Features

Closed Issues

Known Limitations

We recommend verifying any issue encountered with the ServiceNow's REST API explorer first, to make sure it's not due to any setting or restriction related with your instance.

 Installation and Configuration Notes

See the IBM Security Verify Governance ServiceNow Adapter Installation and Configuration Guide for detail instructions.

The ServiceNow Adapter Installation and Configuration Guide can be obtained from the IBM Documentation Website

Updates and corrections to the Installation and Configuration guide

Chapter 1 - Overview

No updates for the current release

Chapter 2 – Planning

No updates for the current release

Chapter 3 - Installing

Service/Target form details

Value that identifies the company

Value that identifies the department

Value that identifies the cost center

Value that identifies the business unit

Value that identifies the location

Value that identifies the building

The above values can be used to specify the source column/attribute in the ServiceNow table that should be used as display value.

As an example: specify code in the cost center value section if you want to use the code values from the cmn_cost_center table as display values to identify cost centers.

Installing in Virtual Appliance (Chapter present under ISVG only)

Add below note to the end of the content of the chapter:

Note: While uploading the Adapter package, you may receive System Error: A file included in the SDI Adapter zip already exists on the system and the Server Message log under Appliance tab of VA will have a reference to error com.ibm.identity.sdi.SDIManagementService E File ibm.com_IBM_Security_Verify_Governance_xxxx.swidtag found in the adapter zip at location ILMT-Tags/ already exists in system. This is because, you can install the same swidtags only once. So, if another adapter of the same type is installed, remove the swidtags.

The ibm.com_IBM_Security_Verify_Governance_Enterprise-xxxx.swidtag file is common to all adapters. In addition to the common swidtag file, an application adapter needs ibm.com_IBM_Security_Verify_Governance_Application_Adapters-xxxx.swidtag file and an infra adapter needs ibm.com_IBM_Security_Verify_Governance_Lifecycle-xxxx.swidtag and ibm.com_IBM_Security_Verify_Governance_Compliance-xxxx.swidtag files. So, if an application adapter is already installed and this is an infra adapter, then only install the infra-specific swidtags and the other way around. Please visit IBM Security Verify Governance Adapters v10.x link to identify the adapter type of the installed adapters.

Chapter 4 - Configuring

Adding custom attributes

Remove :

For attribute with supporting data, such as erServiceNowDepartment:

Set the Assignment in searchUser's Input Map as conn.departmentValue.

In the Override GetNext, search for

if(usersList[currentUser].department)

{usersList[currentUser].departmentValue

= usersList[currentUser].department.value; }

Add the custom attribute. This piece of script is to retrieve the department.value, which is the SYSID.

Assign it to departmentValue which is used in the Input mapping.

In the searchChoice, add the Input Map for supporting data attributes:

erServiceNowDepartmentName maps to conn.erServiceNowDepartmentName,

erServiceNowDepartmentSysID maps to conn.erServiceNowDepartmentSysID

In After Initialize, add the following line for your custom attribute:

addToChoiceMap(supporting data object class anme, titleName,

attribute name, attribute SYSID, url for the table supporting data referred to)

For example, the code for department is:

addToChoiceMap(“erServiceNowDepartmentClass�,�name�,�erServiceNowDepartmentName�,

“erServiceNowDepartmentSysID�,�/api/now/v1/table/cmn_department�)

Add

Adding Custom Attributes

ServiceNow support custom fields for user object. The adapters supports only the standard set of attributes but you can customize the adapter to support custom attributes.

1. Procedure to add a custom attribute u_cpf to sys_user Table:

Extracting Profile jar file :

Copy the adapter profile JAR file and extract the files.

a. Download the adapter package from the IBM® Passport Advantage® website.

b. Copy the ServiceNowProfile.jar file, which is included in the adapter package, into a temporary directory.

c. Run the following command to extract the contents of the ServiceNowProfile.jar file:

cd c:\temp

jar -xvf ServiceNowProfile.jar

The jar command creates the c:\temp\ServiceNowProfile directory.

The JAR file contains a ServiceNowProfile folder with the following files:

• CustomLabels.properties

• erServiceNowAccount.xml

• erServiceNowService.xml

• schema.dsml

• service.def

• ServicenowAL.xml

• targetProfile.json

Updating Schema.dsml :

Update the schema.dsml file, which identifies all of the standard user account attributes. Modify the file to identify new custom attributes.

a. Open schema.dsml in a text editor.

b. Add the custom attribute at the end of attributes.

For example:

<attribute-type single-value="true">

<name>erServiceNowCpf</name>

<object-identifier>1.3.6.1.4.1.6054.3.177.2.1005</object-identifier>

<syntax>1.3.6.1.4.1.1466.115.121.1.15</syntax>

</attribute-type>

Note:

• In the attribute-type, use single-value to indicate whether the attribute is single-value or multi-value.

• The attribute name must start with a prefix erServiceNow to easily identify the attributes that are used with IBM® Security Identity Manager.

• The Object Identifier (OID) is increased by 1. Start a new range of number for custom attribute to avoid OID conflicts with future version of adapters. For example, you can start your attribute OID from 1.3.6.1.4.1.6054.3.177.2.1000, so the first attribute OID is 1.3.6.1.4.1.6054.3.177.2.1001. An error message is displayed if there is any conflict in the OID.

c. Add the Account attributes under Account Objectclass Section

For Example:

<attribute ref="erServiceNowCpf" required="false"/>

Updating CustomLabels.properties :

Add the attribute and its label in the CustomLabels.properties file to show the correct label on Adapter account form.Use the format attribute=label.

For Example:

erServiceNowCpf=Cpf

Updating Assembly Lines:

Modify the assembly lines to add new mappings for the custom attributes. The Assembly Lines in servicenowAl.xml contain mapping instructions from IBM Security Identity Manager request to ServiceNow.

a. Launch the Security Directory Integrator Configuration Editor.

b. Select File > Open Security Directory Integrator Configuration File to open the servicenowAL.xml.

c. Select snAdd > addUser, which contains the mapping for the Add user operation.

d. In the OutputMap, add the name of the custom field exactly as the API Name on ServiceNow.

e. Change the default value of work.[custom field name] to work.[custom attribute name].

For Example:

Add the Work Attribute as work.erServiceNowCpf and Assignment as u_cpf

f. Add the attribute to snModify > Output Map.

For Example:

Add the Work Attribute as work.erServiceNowCpf and Assignment as u_cpf

g. Add the attribute to snRecon. Select searchUser and add the custom attribute.

For Example:

In the Input Map,Set the Work Attribute as erServiceNowCpf and Assignment as conn.u_cpf

Modifying erservicenowaccount.xml:

Modify the adapter form to view or edit the new custom attribute. Otherwise, the attribute is not displayed even if the Assembly Lines work.You can set the attribute value type according to the field type on ServiceNow.

For Example:

<formElement direction="inherit" label="$erServiceNowCpf" name="data.erServiceNowCpf" required="false">

<input name="data.erServiceNowCpf" type="text"/>

</formElement>

Updating the targetprofile.json file 

The Servicenow targetprofile.json file identifies all of the supported service account attributes for the IBM Security Verify Governance. 

About this task 

Modify the targetprofile.json to identify the new extended attributes. 

Procedure 

1.Change to the \servicenowprofile directory, where the targetProfile.json file has been created. 

2.Open the targetProfile.json file in a text editor. 

3.Find the attributes section under userExtension section. 

For example: 

"user Extension": { 

"schema": "urn:ibm:idbrokerage:params:scim:schemas:extension:ServiceNowAccount:2.0:User", 

"definition": { 

"id":"urn:ibm:idbrokerage:params:scim:schemas:extension:ServiceNowAccount:2.0:User", 

 "name": "CustomUserExtension", 

 "description": "Security adapter view of a user", 

 "attributes": [ 

The attributes section contains an array of attribute definitions. Each definition is separated  by a comma. 

4.Add your extended attributes to this attributes section. An attribute object contains the following fields: 

Field 

Description 

Name 

Attributes name. 

Type 

data type (string integer, boolean, binary) 

multiValued 

True, if attribute can have multiple values. 

required 

true, if required attribute. 

caseExact 

true, if value is case-sensitive. 

mutability 

immutable, read, write, readwrite 

returned 

Use "default". 

uniqueness 

User "server". 

specialFlags 

User "none". 

canonicalValues 

Optional list of valid values for this attribute as a json array 

The attribute object is enclosed in braces ({}). Each field has the name in  quotes followed by a colon and the value. Each field is separated by a comma.

For example: 

{

"name": "erServiceNowCpf",

"type": "string",

"multiValued": false,

"description": "Cpf",

"required": false,

"caseExact": false,

"mutability": "readWrite",

"returned": "default",

"uniqueness": "none",

"specialFlags": "none"

},

Ensure that you separate each attribute definition with a comma. After you update the file, it is suggested that you verify that the syntax is correct by using one of the freely available json lint sites.

Generating Jar:

Create a JAR file and install the new adapter profile.

a. Create a JAR file using the files in the \temp directory. Run the following commands:

cd c:\temp

jar -cvf ServiceNowProfile.jar ServiceNowProfile

b. Import the ServiceNowProfile.jar file into the IBM Security Identity server.

c. Restart the dispatcher.

Note: See the LDAP and trace logs if there is a problem loading the profile.

Note:

If the custom field references another table, define the field as supporting data.

Enabling TLSv1.2 in Security Directory Integrator

Procedure:

1. Apply recommended fix packs and limited availability (LA) versions on the Security Directory Integrator. See Recommended fixes for IBM Tivoli Directory Integrator (TDI) & IBM Security Directory Integrator (SDI).

2. After applying the appropriate updates, modify the /solution.properties file by appending the following text to the bottom of the file:

#####################

# # Protocols to enforce SSL protocols in a SDI Server

# # Optional values for com.ibm.di.SSL* property (TLSv1, TLSv1.1, TLSv1.2). # # This can be a multi-valued comma separated property

# # Optional values for com.ibm.jsse2.overrideDefaultProtocol property (SSL_TLSv2, TLSv1,TLSv11,TLSv12).

# # This is a single value property.

#####################

-

com.ibm.di.SSLProtocols=TLSv1,TLSv1.1,TLSv1.2

com.ibm.di.SSLServerProtocols=TLSv1,TLSv1.1,TLSv1.2

com.ibm.jsse2.overrideDefaultProtocol=TLSv1

com.ibm.jsse2.overrideDefaultTLS=true

#####################

Suppressing password in clear text

Last Updated: 2022-03-25

While you are executing the user add and password change operations, the REST API shows the password in clear text.

About this task

To suppress the password in clear text, perform the following steps:

Procedure

Add the following property to the log4j properties file:

log4j.logger.org.apache.http=ERROR, Default

Note: The property must be added after the following property:

log4j.rootCategory=DEBUG, Default

Restart the dispatcher.

Chapter 5 - Troubleshooting

Enabling DEBUG Logs on SDI Server

Procedure

1. Stop the SDI Server process

Pre-7.2.0-ISS-SDI-FP0008

2. Edit the <SDI_Solution_Directory>/etc/log4j.properties

3. Modify the following line:

log4j.rootCategory=INFO, Default

to

log4j.rootCategory=DEBUG, Default

Post-7.2.0-ISS-SDI-FP0008

2. Edit <SDI_HOME>/etc/log4j2.xml

3. Modify the following line:

<Root level="info">

to

<Root level="debug">

4. Start the SDI Server process

5. Re-create the problem and collect the <SDI_Solution_Dir>/logs/ibmdi.log\

Chapter 6 - Uninstalling

No updates for the current release

Chapter 7 - Reference

No updates for the current release

Customizing or Extending Adapter Features

The IBM Security Verify Goverance adapters can be customized and/or extended. The type and method of this customization

may vary from adapter to adapter.

Refer to the ‘IBM Security Verify Governance Adapter Development and Customization Guide’ 

Support for Customized Adapters

The integration to the IBM Security Verify Governance server - the adapter framework - is supported. However, IBM does not support the customizations, scripts, or other modifications. If you experience a problem with a customized adapter, IBM Support may require the problem to be demonstrated on the GA version of the adapter before a case is opened.

Supported Configurations

Installation Platform

The IBM Security Verify Adapter for ServiceNow was built and tested on the following product versions.

Adapter Installation Platform:

Due to continuous Java security updates that may be applied to your IBM Security Verify servers, the following SDI releases are the officially supported versions:

·Security Directory Integrator 7.2 + FP11

Earlier versions of SDI that are still supported may function properly, however to resolve any communication errors, you must upgrade your SDI releases to the officially supported versions by the adapters.

 Managed Resource:

ServiceNow Portal (user accounts only) - Vancouver

ServiceNow On-Premise Solution

Verify Governance

IBM Security Verify Governance Identity Manager v10.0

IBM Security Verify Governance v10.0

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.
1623-14, Shimotsuruma, Yamato-shi
Kanagawa 242-8502 Japan

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.

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
2ZA4/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 information 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 measurements 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.

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 www.ibm.com/legal/copytrade.shtml.

Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.

End of Release Notes