IBM Security Identity adapter for IBM Cloud Identity 7.1.4 is available. Compatibility, installation, and other getting-started issues are addressed.
Copyright
International Business Machines Corporation 2003, 2019. All rights reserved.
US Government Users Restricted Rights -- Use, duplication or disclosure
restricted by GSA ADP Schedule Contract with IBM Corp.
Welcome to the IBM Security Identity adapter for IBM Cloud Identity.
This Release Notes contain information for the following products that was not available when the IBM Security Identity Server manuals were printed:
The SDI-based IBM Security Identity Adapter for IBM Cloud Identity is designed to reconcile users, groups and roles on IBM Cloud Identity. It also supports user management tasks such as account add, modify, suspend, restore and password change.
The adapter runs in "agentless" mode and communicates using HTTPS protocol.
The IBM Identity Adapters are powerful tools that require Administrator Level authority. Adapters operate much like a human system administrator, managing users, groups and permissions. Operations requested from the IBM Security Identity Server will fail if the Adapter is not given sufficient authority to perform the requested task. IBM recommends that this Adapter run with administrative permissions.
Review and agree to the terms of the IBM Security Identity Adapter License prior to using this product.
The license can be viewed from the "license" folder included in the product package.
Adapter Version
|
Component |
Version |
|
Release Date |
2020 March 06 02.32.48 |
|
Adapter Version |
7.1.4 |
|
Component Versions |
Adapter build: 7.1.4.15 Profile: 7.1.4.15 Connector: 7.1.4.15 Dispatcher 7.0.39 or higher (packaged separately) |
|
Documentation |
The following guides are available in the IBM Knowledge Center
IBM Security Identity Adapter for IBM Cloud Identity Installation and Configuration Guide |
New Features
|
Enhancement # (RFE) |
Description |
|
|
Items included in current release (7.1.4) |
|
RTC 186135 |
Internal - Support large number of Users recon with Cloud Identity Adapter |
|
RTC 185179 |
Internal - Support other default attributes on Cloud Identity Adapter |
|
RTC 184337 |
Internal - Support Custom Attributes on Cloud Identity Adapter |
|
RTC 185434 |
Internal – Cloud Identity Adapter must support Roles |
|
|
Items included in 7.1.3 release |
|
|
None |
|
|
Items included in 7.1.2 release |
|
|
Initial release |
Closed Issues
|
Internal# |
APAR# |
Case # / Description |
|
|
|
Items closed in current release (7.1.4) |
|
|
|
None |
|
|
|
Items closed in 7.1.3 release |
|
RTC 184997 |
|
Internal - Groups added while create account operation from ISIM are not visible on ISIM account form UI. |
|
|
|
Items closed in 7.1.2 release |
|
|
|
Initial release. |
Internal# |
APAR# |
Case # / Description |
|
N/A |
N/A |
N/A |
Known Issues
Internal# |
APAR# |
Case # / Description |
|
N/A |
N/A |
While creating Custom Attribute on CI tenant, even if Attribute is created with Number Data type, CI API can accept String as value. So, If Custom Attribute on ISIM is defined as Integer in schema.dsml , then value should be passed as Number.
There is API limitation that API can even accept the string as value for integer attribute.
On ISIM Account form (erTDICloudIDAccount.xml), validation for data types of custom Attributes can be added so that integer custom attribute will accept strictly number value only on ISIM account form.
|
|
N/A |
N/A |
While modifying user attributes for federated user, API returns 204 No Content success response. Therefore, adapter returns success to IBM Security Identity Manager and operation is successful even though the attributes are not set on Cloud Identity resource.
|
|
N/A |
N/A |
Cloud Identity API does not return any error response while trying to connect with invalid resource URL and realm. Therefore, it accepts any value for URL and realm, but test connection will show success message on IBM Security Identity Manager regardless of the values for realm and URL.
|
Corrections to Installation Guide
The following correction to install guide apply to this release:
Managing Custom Attributes through Cloud Identity Adapter
The Cloud Identity Adapter supports custom attributes.
The adapter currently supports only String and Integer, single-valued custom attributes.
The custom attributes must be defined in the adapter profile and included in the custom attributes mapping file for the adapter to manage them.
Defining custom attributes in the adapter profile
The attribute name on the IBM Security Identity Manager, must follow the attribute name rules that are defined by its directory server. The attribute name must not have a pipe (|) in it.
The custom attribute must be included in the schema.dsml, CustomLabels.properties and account.xml (erTDICloudIDAccount.xml) files of the adapter profile
Schema.dsml
1. Define the attributes
a. The custom attributes should have a unique OID.
b. You can use next unique OID available for defining the custom attribute.
For example- last attribute defined has OID - 1.3.6.1.4.1.6054.3.189.2.39. So, the next oid in sequence can be used - 1.3.6.1.4.1.6054.3.189.2.40
c. You can also use String OIDs instead of numeric OIDs. For example - myAttribute-OID
2. Add the reference of attributes to the account object class
For more details - Please refer Custom Adapter Development Guide - Schema.dsml section.
CustomLabels.properties
The CustomLabels.properties file contains labels for the attributes defined in the schema.dsml file.
You must create a label for every custom attribute defined in the schema.dsml file.
Account form xml file (erTDICloudIDAccount.xml)
To display the custom attributes on ISIM, add the custom attributes to the account form xml file.
You can use the Custom Attributes tab already present in erTDICloudIDAccount.xml file for adding custom attributes to ISIM account form -
<tab index="2" selected="false">
<title>$ertdicloudidtentitycustomattr</title>
<image/>
<url>javascript:switchTabs(document.forms['body'],2);</url>
<! -- Add Custom Attributes here -- >
</tab>
You can also use the “Design Forms” feature to add the attribute on the account form.
targetProfile.json
1. Add the definitions of custom attributes in targetProfile.json file as well to manage custom attributes from IGI.
a. Open the targetProfile.json file in a text editor. Find the section for “userExtension”.
b. Under userExtension section - The “attributes” section contains an array of attribute definitions. Each definition is separated by a comma.You add the custom attribute’s definition to this section.
c. 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.
d. Add the custom attributes to the userExtension schema. For example (custom attribute definition - erCompanyName):
"userExtension": {
"schema": "urn:ibm:idbrokerage:params:scim:schemas:extension:CloudIDAdapterAccount:2.0:User",
"definition": {
"id": "urn:ibm:idbrokerage:params:scim:schemas:extension:CloudIDAdapterAccount:2.0:User",
"name": "CustomUserExtension",
"description": "Security adapter view of a user",
"attributes": [
{
"name": "eruid",
"type": "string",
"multiValued": false,
"description": "A identifier used to uniquely identify a user",
"required": true,
"caseExact": false,
"mutability": "immutable",
"returned": "default",
"uniqueness": "server",
"specialFlags": "sys"
},
…
{
"name": "erCompanyName",
"type": "string",
"multiValued": false,
"description": "Company Name",
"required": false,
"caseExact": false,
"mutability": "readWrite",
"returned": "default",
"uniqueness": "none",
"specialFlags": "none"
}
] },
2. Make sure to separate each attribute definition with a comma. Once you have updated the file, it is recommended that you verify the syntax is correct by using one of the freely available json lint sites.
3. Create the profile JAR file with updated files and import to IGI for managing custom attributes on IGI.
4. Discovering attributes from target system on IGI.
Custom attributes are included in targetProfile.json. To manage these attributes, follow below step:
Discovering attributes from target system.
Follow steps given in IGI documentation to discover attributes on IGI.
Including custom attributes in the custom attribute mapping file
A different attribute name can be used on IBM Security Identity Manager than the custom attribute name on Cloud Identity tenant.
The custom attribute mapping file provides mapping between the attributes on ISIM and Cloud Identity tenant.
Adding custom attributes to the mapping file
1. Add the custom attribute name on ISIM and custom attribute name (Attribute identifier) defined on CI tenant separated by pipe (|) like this -
erCompanyName|CompanyName.
where erCompanyName is custom attribute name on ISIM. CompanyName is custom attribute name (Attribute identifier) defined on CI tenant. Pipe (|) is used as delimiter.
2. Specify each custom attribute on a separate line
3. Save the file as .txt text file
4. A sample mapping file is provided in the adapter package
Using the custom attributes to the mapping file
1. Specify the file path for the mapping file on the service form
For e.g.: C:\Program Files\ibm\SDI\V7.2\timsol\CI\CustomMappingFile.txt
2. Restart the Dispatcher service
Installing third-party client libraries
Please add below note in install guide under section “Installing third-party client libraries”
Under Procedure section, mention below note -
Note - If there is any issue regarding NoClassDefFoundError, copy these files into SDI_HOME\jars\patches instead of SDI_HOME\jars\3rd party\others.
Enabling TLSv1.2 in SDI –
1.Apply recommended fix packs and LA versions on SDI by referring to below link –
https://www.ibm.com/support/pages/node/712883
2.After applying the appropriate updates, modify the <SOLUTION_DIRECTORY>/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.1,TLSv1.2
com.ibm.di.SSLServerProtocols=TLSv1.1,TLSv1.2
com.ibm.jsse2.overrideDefaultProtocol=TLSv12
com.ibm.jsse2.overrideDefaultTLS=true
3. Restart Dispatcher service and try connecting to tenants which are using TLSv1.2.
Configuration Notes
None
The IBM Security Identity 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 Identity Adapter Development and Customization Guide’
Support for Customized Adapters
The integration to the IBM Security Identity 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.
Installation Platform
The IBM Security Identity Adapter for IBM Cloud Identity was built and tested on the following product versions.
Adapter Installation Platform:
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:
IBM Cloud Identity
IBM Security Identity Manager:
IBM Security Identity Manager v7.0.x
Identity Governance and Intelligence (IGI):
IGI 5.2.x
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.