IBM Security Verify Adapter v10.0.1 for Box is available. Compatibility, installation, and other getting-started issues are addressed.
Copyright International Business Machines Corporation 2003,
2021. 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 Verify Adapter v10.0.1 for Box.
These Release Notes contain information for the following products that was not available when the IBM Security Verify Adapter manuals were printed:
The Box Adapter is designed to create and manage User Accounts on the Box platform. The adapter runs in "agentless" mode and communicates using HTTPS and LDAP protocol.
IBM recommends the installation of this Adapter (and the prerequisite IBM Tivoli Directory Integrator) on each node of an IBM Security Verify Adapter WAS cluster. A single copy of the adapter can handle multiple IBM Security Verify Adapter Services. The deployment configuration is based, in part, on the topology of your network domain, but the primary factor is the planned structure of your IBM Security Verify Adapter Provisioning Policies and Approval Workflow process. Please refer to the IBM Security Verify Adapter Knowledge Center for a discussion of these topics.
The IBM Security Verify 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 Adapter server will fail if the Adapter is not given sufficient authority to perform the requested task. IBM recommends that this Adapter run with administrative (root) permissions.
Adapter Version
Component |
Version |
Build Date |
2021 December 08 09.49.11 |
Adapter Version |
10.0.1 |
Component Versions |
Adapter build: 10.0.1.29 Profile: 10.0.1.29 Connector: 10.0.1.29 Dispatcher 7.0.32 or higher (packaged separately) |
Documentation |
The following guides are available in the IBM Knowledge Center: ?? Box Adapter Installation and Configuration Guide |
New Features
Enhancement # (FITS) |
Description |
|
Items included in current release (10.0.1) |
|
None
|
|
Items included in current release (7.1.7) |
|
None
|
|
Items included in 7.1.6 release |
|
None
|
|
Items included in 7.1.5 release |
|
Add support for IGI 5.2.2
This adapter is now designed for use with IBM Security Identity Manager, Privileged Identity Manager, and Identity Governance and Intelligence |
|
Items included in 7.0.4 release
|
|
None
|
|
Items included in 7.0.3 release |
|
None
|
|
Items included in 7.0.2 release |
|
None
|
|
Items included in 7.0.1 release |
|
Initial Release
|
Closed Issues
Internal# |
APAR# |
PMR# / Description |
|
|
Items closed in current release 10.0.1 |
RTC 189961 |
|
typo when testing the the BoxProfile with target profile generator.In the schema.dsml the erBoxPagingOffset attribute has (ture instead of true):"<(attribute-type) single-value="ture">"
|
|
|
Items included in current release 7.1.7 |
RTC 182559 |
|
As a Box adapter developer, I must ensure that the mapping for dn is correct in attributemapping.def file
|
|
|
Items included in 7.1.6 release
|
172325 |
IJ03790 |
Full recon fails with unauthorized error
|
|
|
Items included in 7.1.5 release |
152320 |
91092,227,000 |
TEST of Box Adapter fails, due to missing boxConfig.properties
|
|
|
Items included in 7.0.4 release
|
144357 |
|
Reply unsuccessful status if a request fail due to connection problem or any reason.
|
144501 |
|
Update the release notes for the limitation of updating Box Login Email and update the field as read only on Modify.
|
146656 |
|
Add "Managing subset of box accounts" section to the adapter release notes.
|
|
|
Items included in 7.0.3 release
|
136485 |
|
Support filter query and pagination in reconciliation ,and protect client ID and refresh token in logging.
|
138068 |
|
Handle eraccountstatus in Modify Operation
|
|
|
Items included in 7.0.2 release |
133525 |
|
Client Secret field is updated from clear text to password type. And the release note is updated giving information how to configure the server to encrypt the password field.
|
|
|
Items included in 7.0.1 release |
|
|
Initial release.
|
Known Issues
Internal# |
APAR# |
PMR# / Description |
N/A |
N/A |
Box Login Email can not be changed. If it is changed on Box Console, the account on ISIM will become orphan in next reconciliation process.
|
N/A |
N/A |
The adapter does not support change of Group Name. This is a limitation of the IBM Security Identity Manager. Attempting to change the Group Name will result in the following error: " CTGIMI046E You cannot change the value of the attribute that is mapped to ergroupname."
|
N/A |
N/A |
Adding members to a group from Manage Groups Users can be added to a group only with Member access from Manage Groups. To give admin access to the user for a specified group, must go to the User Account Form and add the group to the Admin groups list. Deleting a group which has members with Admin Access After removing a group, the group ID still remains in the Admin Groups List box of the User Account Form. It will be completely removed from the Account Form UI in the next reconcilation process.
|
N/A |
N/A |
Updating Box Account Status in Account Form If the Box Account Status is updated in suspended state, the status change will not be reflected on Box server and the update operation is successful with warnning message. As a result, the status shown in ISIM Account Form will not be consistent with the status shown on Box in terms of User Interface. To advoid that, the account has to be restored first in ISIM before making changes to the Account Status.
|
N/A |
N/A |
Unable to reflect data change that happened on Box The modification done on Box Server will not be reflected to ISIM automatically. To synchronize the changes back to ISIM, the reconciliation process has to be performed. Users added as a Group Admin to any box group on box resource will not be visible on ISIM even after reconciliation. Only users added as member to Box Group will be displayed.
|
See the IBM Security Verify Adapter Installation Guide for detailed instructions.
The following corrections applies to the current release.
Register an API key by creating a custom application for the adapter on the managed resource.
Note:
Follow the instructions in "Oauth2-Setup" to register the custom app.While you are configuring the Box custom app, select Manage Users and Manage Groups under the Application scopes -> Administrative actions to perform enterprise management on users and groups by Box Adapter.
After you register, you must generate security tokens with client ID and client secret which can be obtained from the configuration section of the registered application.
Follow the below steps to generate the Access and Refresh token.
Example:
Refer "Get Authorize API" to authorise the box user to the app.
Perform GET request in POSTMAN.
GET https://account.box.com/api/oauth2/authorize?response_type=code&client_id=klxcows8s34fekwl8zd3w7hakmseu250
On 200 OK, Save the response as html.
Open the Response.html file and provide the box admin userid and pwd when prompted. On the next step grant access to the app.
Get the code from the redirect url.
Refer "Oauth2-token" for token generation process
Example:
Perform POST request in POSTMAN
POST https://api.box.com/oauth2/token/
BODY x-www-form-urlencoded
client_id [CLIENT_ID]
client_secret [CLIENT_SECRET]
code [CODE generated in Step 1]
grant_type authorization_code
Installing ILMT-Tags File
Please add new section ???Installing
ILMT-Tags File ???under the section Installing in adapter install guide.
Under Installing ILMT-Tags specify below steps.
Before you begin:
The Dispatcher must be installed
Procedure:
Copy the files from ILMT-Tags folder to the specified location:
1. Windows: <SDI-HOME>/swidtag
2. Unix/Linux: <SDI-HOME>/swidtag
Configuration Notes
The following configuration notes apply to this release:
The service form of the adapter has been enhanced to provide the ability to manage a subset of the box users. The following optional service attributes allows you to set limitations and filters during reconciliation.
These attributes must be used with caution and are not intended to be changed between reconciliation. The purpose of this feature is to limit the adapter service to manage the same subset of the users. Changing the values between reconciliation will result in data inconsistency.
For example, if the filter is set to manage all users that starts with the letter "a", the adapter will return all accounts with either the name or the login starts with "a". In a subsequent reconciliation, if the filter was changed to manage all users that starts with the letter "b", then all the users that starts with the letter "a" will be removed from the local repository ( ISIM or IGI local data ).
Another example, if the filter is set to manage all users that starts with the letter "a", then the adapter service is used to create a box user that starts with the letter "b", the reconciliation will not return the newly created user that starts with "b" and it will be removed of the local repository.
By default, the Client Secret is stored as clear text. To store it in encrypted form in the server, perform the following task:
Procedure
1. Update the enRole.properties file that is located under the ISIM_HOME\data directory. Append the attribute erboxclientsecret to the list of attributes of the password.attributes property.
2. password.attributes=ersynchpassword erServicePassword erServicePwd1 erServicePwd2 erServicePwd3 erServicePwd4 erADDomainPassword erPersonPassword erNotesPasswdAddCert eritamcred erep6umds erposixpassphrase erboxclientsecret
3. Save the file and restart the ISIM Server.
Web
Application component is avalialbe to generate Box Tokens. This feature can be
use as a replacement of the manual token generation process.
Note:// This is an optional feature for the Box Adapter.
The IBM Security Verify Adapters can be customized and/or extended. The type and method of this customization may vary from adapter to adapter.
Getting Started
Customizing and extending adapters requires a number of additional skills. The developer must be familiar with the following concepts and skills prior to beginning the modifications:
Note: If the customization requires a new IBM Tivoli Directory Integrator connector, the developer must also be familiar with IBM Tivoli Directory Integrator connector development and working knowledge of Java programming language.
Managed Resources:
Check the "Training" section of the IBM Security Verify Adapter Support web site for links to training, publications, and demos.
IBM Tivoli Directory Integrator Resources:
Check the "Training" section of the IBM Tivoli Directory Integrator Support web site for links to training, publications, and demos.
Support for Customized Adapters
The integration to the IBM Security Verify 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 PMR is opened.
Installation Platform
The IBM Security Identity Manager Adapter 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:
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. Please refer to the adapters installation and configuration guides for the latest update on IBM Security Directory Integrator versions and fix packs
Managed Resource:
IBM Security Identity Governance and Intelligence v5.2.x
IBM Security Verify Governance Identity Manager v10.0(on External???s TDI only)
IBM Security Verify Governance v10.0
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:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, 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 may 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.
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.
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.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or its affiliates.
Cell Broadband Engine is a trademark of Sony Computer Entertainment, Inc. in the United States, other countries, or both and is used under license therefrom.
Linear Tape-Open, LTO, the LTO Logo, Ultrium, and the Ultrium logo are trademarks of HP, IBM Corp. and Quantum in the U.S. and other countries.
Other company, product, and service names may be trademarks or service marks of others.