Installation and configuration reference for the connectors that are supported with ForgeRock® Identity Management software. This reference includes installation and configuration instructions for each connector, and examples that demonstrate how to use the connectors in a deployment.

# Preface

ForgeRock Identity Platform™ serves as the basis for our simple and comprehensive Identity and Access Management solution. We help our customers deepen their relationships with their customers, and improve the productivity and connectivity of their employees and partners. For more information about ForgeRock and about the platform, see https://www.forgerock.com.

This guide describes the ICF connectors that are supported in a deployment of ForgeRock Identity Management. The guide focuses on getting the connectors installed and configured with ForgeRock Identity Management software.

This guide does not describe all ICF connectors. Additional connectors are available from the ForgeRock BackStage download site.

This guide is written for anyone using supported ICF connectors with ForgeRock Identity Management software.

You do not need to have a complete understanding of ForgeRock Identity Management to learn something from this guide, although a background in identity management and maintaining web application software can help. You do need some background in managing services on your operating systems and in your application servers. You can nevertheless get started with this guide, and learn more as you go along.

## 2. Accessing Documentation Online

ForgeRock publishes comprehensive documentation online:

• The ForgeRock Knowledge Base offers a large and increasing number of up-to-date, practical articles that help you deploy and manage ForgeRock software.

While many articles are visible to community members, ForgeRock customers have access to much more, including advanced information for customers using ForgeRock software in a mission-critical capacity.

• ForgeRock product documentation, such as this document, aims to be technically accurate and complete with respect to the software documented. It is visible to everyone and covers all product features and examples of how to use them.

## 3. Using the ForgeRock.org Site

The ForgeRock.org site has links to source code for ForgeRock open source software, as well as links to the ForgeRock forums and technical blogs.

If you are a ForgeRock customer, raise a support ticket instead of using the forums. ForgeRock support professionals will get in touch to help you.

# Chapter 1. Connector Overview

IDM bundles connectors in the /path/to/openidm/connectors directory. ForgeRock supports a number of additional connectors that you can download from the ForgeRock Download Center.

For instructions on building connector configurations interactively, see "Configuring Connectors" in the Integrator's Guide.

All the connectors described in this guide are supported. This list indicates the connectors that are bundled with IDM 6.5.1.0:

 The Adobe Marketing Cloud connector lets you manage profiles in an Adobe Campaign data store. The CSV file connector is useful when importing users, either for initial provisioning or for ongoing updates. When used continuously in production, a CSV file serves as a change log, often containing only user records that have changed. The Database Table connector enables provisioning to a single table in a JDBC database. The Google Apps connector lets you interact with Google's web applications. The scripted Groovy Connector lets you run a Groovy script for any ICF operation, such as search, update, create, and others, on any external resource. The Kerberos connector is an implementation of the SSH connector, and is based on Java Secure Channel (JSch) and the Java implementation of the Expect library (Expect4j). This connector lets you manage Kerberos user principals from IDM. The LDAP connector is based on JNDI, and can be used to connect to any LDAPv3-compliant directory server, such as ForgeRock Directory Services (DS), Active Directory, SunDS, Oracle Directory Server Enterprise Edition, IBM Security Directory Server, and OpenLDAP. The Marketo connector lets you synchronize between IDM managed users and a Marketo Leads Database. The MongoDB connector is an implementation of the Scripted Groovy Connector. This connector lets you interact with a MongoDB document database, using Groovy scripts for the ICF operations. The Salesforce connector enables provisioning, reconciliation, and synchronization between Salesforce and the IDM repository. The SCIM connector is based on the Simple Cloud Identity Management (SCIM) protocol and lets you manage user and group accounts on any SCIM-compliant resource provider, such as Slack, Facebook or SalesForce. The Scripted REST connector is an implementation of the Scripted Groovy Connector. This connector lets you interact with any REST API, using Groovy scripts for the ICF operations. The Scripted SQL connector is an implementation of the Scripted Groovy Connector. This connector lets you interact with any SQL database, using Groovy scripts for the ICF operations. The ServiceNow connector lets you manage objects in the ServiceNow platform, integrating with ServiceNow's REST API. The SSH connector is an implementation of the Scripted Groovy Connector, and is based on Java Secure Channel (JSch) and the Java implementation of the Expect library (Expect4j). This connector lets you interact with any SSH server, using Groovy scripts for the ICF operations. The Workday connector lets you synchronize user accounts between IDM and Workday's cloud-based HR system.

This list indicates the connectors that are not bundled with IDM 6.5.1.0 but available from the ForgeRock Download Center:

 The HubSpot connector lets you synchronize HubSpot contacts and companies with managed objects in an IDM repository. The PowerShell connector is not a complete connector in the traditional sense, but a framework within which you write your own PowerShell scripts to address the requirements of your Microsoft Windows ecosystem. Use this connector to create custom connectors that can provision any Microsoft system, such as Active Directory, Microsoft SQL, MS Exchange, SharePoint, Azure, and Office365. The SAP connector is an implementation of the Scripted Groovy Connector that connects to any SAP system using the SAP JCo Java libraries.

# Chapter 2. Generic LDAP Connector

The generic LDAP connector is based on the Java Naming and Directory Interface (JNDI), and can be used to connect to any LDAPv3-compliant directory server, such as ForgeRock Directory Services (DS), Active Directory, SunDS, Oracle Directory Server Enterprise Edition, IBM Security Directory Server, and OpenLDAP.

Because it is based on JNDI, the LDAP connector is restricted to the attribute types that are supported by JNDI. JNDI supports only strings and an array of bytes. If you attempt to use different attribute value types, the connector throws a malformed attribute value exception. For more information, see the corresponding JNDI documentation.

ICF provides a legacy Active Directory (AD) .NET connector. Note, however, that the AD Connector is deprecated and support for its use with IDM will be discontinued in a future release. For simple Active Directory (and Active Directory LDS) deployments, the generic LDAP Connector works better than the Active Directory connector, in most circumstances. Using the generic LDAP connector avoids the need to install a remote connector server in the overall deployment. In addition, the generic LDAP connector has significant performance advantages over the Active Directory connector. For more complex Active Directory deployments, use the PowerShell Connector Toolkit, as described in "PowerShell Connector Toolkit".

## 2.1. Setting Up the Generic LDAP Connector

IDM bundles version 1.5.19.1 of the LDAP connector. Three sample LDAP connector configurations are provided in the path/to/openidm/samples/example-configurations/provisioners/ directory:

• provisioner.openicf-dsldap.json provides a sample LDAP connector configuration for a ForgeRock Directory Services (DS) server.

• provisioner.openicf-adldap.json provides a sample LDAP connector configuration for an Active Directory server.

• provisioner.openicf-adldsldap.json provides a sample LDAP connector configuration for an Active Directory Lightweight Directory Services (AD LDS) server.

You should be able to adapt one of these sample configurations for any LDAPv3-compliant server.

The connectorRef configuration property provides information about the LDAP connector bundle, and is the same in all three sample LDAP connector configurations:

{
"connectorRef": {
"connectorHostRef": "#LOCAL",
"connectorName": "org.identityconnectors.ldap.LdapConnector",
"bundleName": "org.forgerock.openicf.connectors.ldap-connector",
"bundleVersion": "[1.5.19.0,1.6.0.0)"
}
}

The connectorHostRef property is optional, if you use the connector .jar provided in openidm/connectors, and you use a local connector server.

The following excerpt shows the configuration properties in the sample LDAP connector for DS. These properties are described in detail later in this section. For additional information on the properties that affect synchronization, see "Controlling What the LDAP Connector Synchronizes". For a complete list of the configuration properties for the LDAP connector, see "LDAP Connector Configuration":

"configurationProperties" : {
"host" : "localhost",
"port" : 1389,
"ssl" : false,
"startTLS" : false,
"privateKeyAlias" : null,
"alternateKeyStore" : null,
"alternateKeyStoreType" : null,
"principal" : "cn=Directory Manager",
"baseContexts" : [
"dc=example,dc=com"
],
"baseContextsToSynchronize" : [
"dc=example,dc=com"
],
"accountSearchFilter" : null,
"accountSynchronizationFilter" : null,
"groupSearchFilter" : null,
"groupSynchronizationFilter" : null,
"removeLogEntryObjectClassFromFilter" : true,
"modifiersNamesToFilterOut" : [ ],
"changeLogBlockSize" : 100,
"attributesToSynchronize" : [ ],
"changeNumberAttribute" : "changeNumber",
"objectClassesToSynchronize" : [
"inetOrgPerson"
],
"vlvSortAttribute" : "uid",
"useBlocks" : false,
"maintainPosixGroupMembership" : false,
"failover" : [ ],
"accountObjectClasses" : [
"top",
"person",
"organizationalPerson",
"inetOrgPerson"
],
"uid"
],
"groupMemberAttribute" : "uniqueMember",
"usePagedResultControl" : true,
"blockSize" : 100,
"uidAttribute" : "entryUUID",
"maintainLdapGroupMembership" : false,
},
host

The host name or IP address of the server on which the LDAP instance is running.

port

The port on which the LDAP server listens for LDAP requests. The sample configuration specifies a default port of 1389.

ssl

If true, the specified port listens for LDAPS connections.

For instructions on using the LDAP connector over SSL, see "Configuring the LDAP Connector to Use SSL and StartTLS".

startTLS

Specifies whether to use the startTLS operation to initiate a TLS/SSL session. To use startTLS, set "startTLS":true, and "ssl":false. Your connection should use the insecure LDAP port (typically 389 or 1389 for a DS server).

Specify the certificates that should be used for authentication, as described in "Configuring the LDAP Connector to Use SSL and StartTLS".

principal

The bind DN that is used to connect to the LDAP server.

credentials

The password of the principal that is used to connect to the LDAP server.

baseContexts

One or more starting points in the LDAP tree that will be used when searching the tree. Searches are performed when discovering users from the LDAP server or when looking for the groups of which a user is a member. During reconciliation operations, IDM searches through the base contexts listed in this property for changes. (See also "Controlling What the LDAP Connector Synchronizes").

baseContextsToSynchronize

One or more starting points in the LDAP tree that will be used to determine if a change should be synchronized. During liveSync operations, IDM searches through the base contexts listed in this property for changes. If no value is specified here, the values in listed in the baseContexts property are used. (See also "Controlling What the LDAP Connector Synchronizes").

accountSynchronizationFilter

Used during synchronization actions to filter out LDAP accounts. (See also "Controlling What the LDAP Connector Synchronizes").

accountObjectClasses

This property lists all the object classes that represent an account. If this property has multiple values, an AND filter is used to determine the affected entries. For example, if the value of this property is ["organizationalPerson", "inetOrgPerson"], any entry with the object class organizationalPerson AND the object class inetOrgPerson is considered as an account entry. You can override the value of this property by specifying the user object classes during the create operation.

If no object class is specified when you create a user, this property is used as the default list of object classes for the new entry.

accountSearchFilter

Search filter that user accounts must match. (See also "Controlling What the LDAP Connector Synchronizes").

accountUserNameAttributes

Attributes holding the account's user name. Used during authentication to find the LDAP entry matching the user name.

attributesToSynchronize

List of attributes used during object synchronization. IDM ignores change log updates that do not include any of the specified attributes. If empty, IDM considers all changes. (See also "Controlling What the LDAP Connector Synchronizes").

blockSize

Block size for simple paged results and VLV index searches, reflecting the maximum number of entries retrieved at any one time.

changeLogBlockSize

Block size used when fetching change log entries.

changeNumberAttribute

Change log attribute containing the last change number.

failover

LDAP URLs specifying alternative LDAP servers to connect to if IDM cannot connect to the primary LDAP server specified in the host and port properties.

filterWithOrInsteadOfAnd

In most cases, the filter to fetch change log entries is AND-based. If this property is set, the filter ORs the required change numbers instead.

groupMemberAttribute

LDAP attribute holding members for non-POSIX static groups.

groupSearchFilter

Search filter that group entries must match.

maintainLdapGroupMembership

If true, IDM modifies group membership when entries are renamed or deleted.

Does not apply to Active Directory.

In the sample LDAP connector configuration file provided with IDM, this property is set to false. This means that LDAP group membership is not modified when entries are renamed or deleted in IDM. To ensure that entries are removed from LDAP groups when the entries are deleted, set this property to true or enable referential integrity on the LDAP server. For information about configuring referential integrity in DS, see Configuring Referential Integrity in the Developer's Guide for ForgeRock Directory Services.

maintainPosixGroupMembership

If true, IDM modifies POSIX group membership when entries are renamed or deleted.

modifiersNamesToFilterOut

Use this property to avoid loops caused by changes made to managed user objects being synchronized. For more information, see "Controlling What the LDAP Connector Synchronizes".

objectClassesToSynchronize

IDM synchronizes only entries that have these object classes. See also "Controlling What the LDAP Connector Synchronizes".

passwordAttribute

Attribute to which IDM writes the predefined PASSWORD attribute.

passwordHashAlgorithm

Hash password values with the specified algorithm, if the LDAP server stores them in clear text.

The hash algorithm can be one of the following:

• NONE - Clear text

• WIN-AD - Used for password changes to Active Directory

• SHA - Secure Hash Algorithm

• SHA-1 - A 160-bit hash algorithm that resembles the MD5 algorithm

• SSHA - Salted SHA

• MD5 - A 128-bit message-digest algorithm

• SMD5 - Salted MD5

readSchema

If true, read the schema from the LDAP server.

This property is used only during the connector setup, to generate the object types.

If this property is false, the LDAP connector provides a basic default schema that can manage LDAP users and groups. The default schema maps inetOrgPerson to the OpenICF __ACCOUNT__ property, and groupOfUniqueNames to the OpenICF __GROUP__ property. The following LDAP object classes are also included in the default schema:

 organization organizationalUnit person organizationalPerson account groupOfNames
removeLogEntryObjectClassFromFilter

If true, the filter to fetch change log entries does not contain the changeLogEntry object class, and IDM expects no entries with other object types in the change log. The default setting is true.

respectResourcePasswordPolicyChangeAfterReset

If true, bind with the Password Expired and Password Policy controls, and throw PasswordExpiredException and other exceptions appropriately.

uidAttribute

Specifies the LDAP attribute that should be used as the immutable ID for the entry. For a DS resource, you should use the entryUUID. Although you can use a DN (or any unique attribute) for the _id, as a best practice, you should use an attribute that is both unique and immutable, such as the entryUUID.

useBlocks

If useBlocks is false, no pagination is used. If useBlocks is true, the connector uses block-based LDAP controls, either the simple paged results control, or the virtual list view control, depending on the setting of the usePagedResultControl property.

usePagedResultControl

Taken into account only if useBlocks is true. If usePagedResultControl is false, the connector uses the virtual list view (VLV) control, if it is available. If usePagedResultControl is true, the connector uses the simple paged results control for search operations.

useTimestampsForSync

If true, use timestamps for liveSync operations, instead of the change log.

By default, the LDAP connector has a change log strategy for LDAP servers that support a change log, such as ForgeRock Directory Services (DS) and Oracle Directory Server Enterprise Edition. If the LDAP server does not support a change log, or if the change log is disabled, liveSync for create and modify operations can still occur, based on the timestamps of modifications.

vlvSortAttribute

Attribute used as the sort key for virtual list view.

sendCAUDTxId

If true, propagate the Common Audit Transaction ID to a DS server.

## 2.2. Configuring the LDAP Connector to Use SSL and StartTLS

To use the LDAP connector over SSL, update your connector configuration file as follows:

1. For a connection over SSL, set the ssl property to true and set the port to a secure port, for example, 636.

To initiate a connection using startTLS, set "startTLS":true, and "ssl":false. Set the port to an insecure LDAP port, for example, 389.

2. If you are using a CA-signed server certificate, add that certificate to the IDM truststore, for example:

$cd /path/to/openidm/security$ keytool \
-importcert \
-alias server-cert \
-keystore truststore \
-storepass changeit \
-file /path/to/server-cert.crt
3. Specify the certificate that the LDAP connector will use to authenticate to the remote LDAP server.

By default, the LDAP connector uses the self-signed certificate that is generated in the IDM keystore when IDM first starts up. You have two options to change this default behavior:

1. Set the privateKeyAlias to the alias of a certificate in the IDM keystore. The alias name is case-sensitive.

If you set privateKeyAlias to null, no private key is sent during the SSL handshake, so only the server certificate is used. You must import the server certificate into the IDM truststore, as shown in the previous step.

If privateKeyAlias is set to an alias within the IDM keystore, the connector uses that private key for SSL mutual authentication.

2. Specify a different keystore for the connector.

If you do not want to use the default IDM keystore, set the following properties:

• alternateKeyStore - specifies the full path to an alternate keystore.

• alternateKeyStoreType - specifies alternate keystore type. Valid values are JKS, JCEKS and PKCS12.

• alternateKeyStorePassword - specifies password for the alternate keystore.

4. (Optional) Enable hostname verification to prevent a third party from manipulating DNS entries or spoofing the LDAP Server IP.

When hostname verification is enabled, the connector compares the hostname in the certificate subject and subjectAltName with a simple hostname pattern defined in the hostNameVerification property.

To enable hostname verification, set "hostNameVerification" : true and set the hostNameVerification property to the hostname you want to match. If the pattern matches, the connector is initialized successfully. If the pattern does not match, connector initialization throws an error. The hostNameVerification property supports wild card matching.

Assume, for example, a server certificate principal hostname of server1.example.com. With the following connector configuration, IDM starts up and the connector is initialized:

"configurationProperties" : {
...
"hostNameVerification" : true,
"hostNameVerifierPattern" : "server1.example.com",
...
}    

Similarly, with the following connector configuration, IDM starts up and the connector is initialized:

"configurationProperties" : {
...
"hostNameVerification" : true,
"hostNameVerifierPattern" : "*.example.com",
...
}    

With the following connector configuration, IDM starts up but connector initialization throws an error:

"configurationProperties" : {
...
"hostNameVerification" : true,
"hostNameVerifierPattern" : "server2.example.com",
...
}    

The error returned is similar to the following:

The host name from the server certificate'CN=server1.example.com' does not match the provided pattern 'server2.example.com'

## 2.3. Controlling What the LDAP Connector Synchronizes

To control the set of LDAP entries that are affected by reconciliation and automatic synchronization operations, set the following properties in the provisioner configuration. Automatic synchronization operations includes liveSync (synchronization of changes from the LDAP server to IDM) and implicit sync (synchronization from IDM to the LDAP server).

baseContexts

The starting points in the LDAP tree that are used when searching the directory tree, for example, dc=example,dc=com. These base contexts must include the set of users and the set of groups that must be searched during reconciliation operations.

baseContextsToSynchronize

The starting points in the LDAP tree that are used to determine if a change should be synchronized. This property is used only for automatic synchronization operations. Only entries that fall under these base contexts are considered during synchronization operations.

accountSearchFilter

Only user accounts that match this filter are searched, and therefore affected by reconciliation and synchronization operations. If you do not set this property, all accounts within the base contexts specified previously are searched.

accountSynchronizationFilter

This property is used during reconciliation and automatic synchronization operations, and filters out any LDAP accounts that you specifically want to exclude from these operations.

objectClassesToSynchronize

During automatic synchronization operations, only the object classes listed here are considered for changes. IDM ignores change log updates (or changes to managed objects) which do not have any of the object classes listed here.

attributesToSynchronize

During automatic synchronization operations, only the attributes listed here are considered for changes. Objects that include these attributes are synchronized. Objects that do not include these attributes are ignored. If this property is not set, IDM considers changes to all attributes specified in the mapping. Automatic synchronization includes liveSync and implicit synchronization operations. For more information, see "Types of Synchronization" in the Integrator's Guide

This attribute works only with LDAP servers that log changes in a change log, not with servers (such as Active Directory) that use other mechanisms to track changes.

modifiersNamesToFilterOut

This property lets you define a list of DNs. During synchronization operations, the connector ignores changes made by these DNs.

When a managed user object is updated, and that change is synchronized to the LDAP server, the change made on the LDAP server is recorded in the change log. A liveSync operation picks up the change, and attempts to replay the change on the managed user object, effectively resulting in a loop of updates.

To avoid this situation, you can specify a unique user in your LDAP directory, that will be used only for the LDAP connector. The unique user must be something other than cn=directory manager, for example cn=openidmuser. You can then include that user DN as the value of modifiersNamesToFilterOut. When a change is made through the LDAP connector, and that change is recorded in the change log, the modifier's name (cn=openidmuser) is flagged and IDM does not attempt to replay the change back to the managed user repository. So you are effectively indicating that IDM should not synchronized changes back to managed user that originated from managed user, thus preventing the update loop.

This attribute works only with LDAP servers that log changes in a change log, not with servers (such as Active Directory) that use other mechanisms to track changes.

## 2.4. Using the Generic LDAP Connector With Active Directory

The LDAP connector provides functionality specifically for managing Active Directory users and groups. This connector is supported with Active Directory Domain Controllers, Active Directory Global Catalogues, and Active Directory Lightweight Directory Services (LDS).

The connector can handle the following operational attributes to manage Active Directory accounts:

__ENABLE__

Uses the userAccountControl attribute to get or set the account status of an object.

The LDAP connector reads the userAccountControl to determine if an account is enabled or disabled. The connector modifies the value of the userAccountControl attribute if IDM changes the value of __ENABLE__.

__ACCOUNT_EXPIRES__

Gets or sets the accountExpires attribute of an Active Directory object.

__LOCK_OUT__

Uses the msDS-User-Account-Control-Computed system attribute to check if a user account has been locked.

If IDM sets __LOCK_OUT__  to FALSE, the LDAP connector sets the Active Directory lockoutTime to 0 to unlock the account.

If IDM sets __LOCK_OUT__  to TRUE, the LDAP connector ignores the change and logs a message.

__PASSWORD_EXPIRED__

Uses the msDS-User-Account-Control-Computed system attribute to check if a user password has expired.

To force password expiration (that is, to force a user to change their password when they next log in), set pwdLastSet to 0. The LDAP connector sets pwdLastSet to 0, if IDM sets __PASSWORD_EXPIRED__ to TRUE.

To remove password expiration, set pwdLastSet to 0 and then to -1. This sets the value of pwdLastSet to the current time. The LDAP connector sets pwdLastSet to -1 if IDM sets __PASSWORD_EXPIRED__ to FALSE.

### Note

Active Directory does not allow you to create an enabled account with an expired password. If you are using __PASSWORD_EXPIRED__ to force a new user to change their password when they next log in, you can create the user account as disabled initially (__ENABLE__=false). You can then patch the new user account to enable it. You can use the same workaround for synchronization operations, creating new user accounts as disabled, then issuing an openidm.patch call in a postCreate script to enable the account.

__CURRENT_PASSWORD__

For a password change request, the connector supplies the __CURRENT_PASSWORD__, along with the new password. The connector can also do a password reset where only the new password is supplied.

The sample connector configuration file (openidm/samples/example-configurations/provisioners/provisioner.openicf-adldap.json) includes these operational attributes.

Note that the passwordAttribute property in this provisioner file is set to unicodePwd. This property specifies the attribute in Active Directory that holds the user password. When a user's password is changed, the new value is set in this attribute.

### 2.4.1. Managing Active Directory Users With the LDAP Connector

If you create or update users in Active Directory, and those user entries include passwords, you must use the LDAP connector over SSL. You cannot create or update an Active Directory user password in clear text. To use the connector over SSL, follow the instructions in "Configuring the LDAP Connector to Use SSL and StartTLS".

The following command adds an Active Directory user. The output shows the operational attributes described in the previous section:

$curl \ --header "Content-Type: application/json" \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ --data '{ "dn": "CN=Brian Smith,CN=Users,DC=example,DC=com", "cn": "Brian Smith", "sAMAccountName": "bsmith", "userPrincipalName": "bsmith@example.com", "userAccountControl": "512", "givenName": "Brian", "mail": "bsmith@example.com", "__PASSWORD__": "Passw0rd" }' \ http://localhost:8080/openidm/system/ad/account?_action=create { "_id": "e1418d64-096c-4cb0-b903-ebb66562d99d", "mobile": null, "postalCode": null, "st": null, "employeeType": [], "objectGUID": "e1418d64-096c-4cb0-b903-ebb66562d99d", "cn": "Brian Smith", "department": null, "l": null, "description": null, "info": null, "manager": null, "sAMAccountName": "bsmith", "sn": null, "whenChanged": "20151217131254.0Z", "userPrincipalName": "bsmith@example.com", "userAccountControl": "512", "__ENABLE__": true, "displayName": null, "givenName": "Brian", "middleName": null, "facsimileTelephoneNumber": null, "lastLogon": "0", "countryCode": "0", "employeeID": null, "co": null, "physicalDeliveryOfficeName": null, "pwdLastSet": "2015-12-17T13:12:54Z", "streetAddress": null, "homePhone": null, "__PASSWORD_NOTREQD__": false, "telephoneNumber": null, "dn": "CN=Brian Smith,CN=Users,DC=example,DC=com", "title": null, "mail": "bsmith@example.com", "postOfficeBox": null, "__SMARTCARD_REQUIRED__": false, "uSNChanged": "86144", "__PASSWORD_EXPIRED__": false, "initials": null, "__LOCK_OUT__": false, "company": null, "employeeNumber": null, "accountExpires": "0", "c": null, "whenCreated": "20151217131254.0Z", "uSNCreated": "86142", "division": null, "groups": [], "__DONT_EXPIRE_PASSWORD__": false, "otherHomePhone": [] } ### Important Previous versions of the LDAP connector appended <GUID= to the GUID for Active Directory objects. This behavior ensured compatibility with the legacy .NET connector. The LDAP connector no longer appends <GUID= to the object GUID. The new GUID format is compatible with objects created using the AD Powershell Connector, for example e1418d64-096c-4cb0-b903-ebb66562d99d. In existing deployments, this might mean that your links are incompatible with the new GUID format. To update links to the new format, run a reconciliation operation. To retain the legacy behavior, set "useOldADGUIDFormat" : true in your provisioner file. Note that the command sets the userAccountControl to 512, which is an enabled account. The value of the userAccountControl determines the account policy. The following list describes the common values for the userAccountControl. 512 Enabled account. 514 Disabled account. 544 Enabled account, password not required. 546 Disabled account, password not required. 66048 Enabled account, password does not expire. 66050 Disabled account, password does not expire. 66080 Enabled account, password does not expire and is not required. 66082 Disabled account, password does not expire and is not required. 262656 Enabled account, smartcard required. 262658 Disabled account, smartcard required. 262688 Enabled account, smartcard required, password not required. 262690 Disabled account, smartcard required, password not required. 328192 Enabled account, smartcard required, password does not expire. 328192 Enabled account, smartcard required, password does not expire. 328194 Disabled account, smartcard required, password does not expire. 328224 Enabled account, smartcard required, password does not expire and is not required. 328226 Disabled account, smartcard required, password does not expire and is not required. ### 2.4.2. Managing Active Directory Groups With the LDAP Connector The following command creates a basic Active Directory group with the LDAP connector: $ curl \
--request POST \
--data '{
"dn": "CN=Employees,DC=example,DC=com"
}' \
{
}

The LDAP connector exposes two special attributes to handle Active Directory group scope and type: GROUP_SCOPE and GROUP_TYPE.

The GROUP_SCOPE attribute is defined in the provisioner configuration as follows:

...
"__GROUP_SCOPE__" : {
"type" : "string",
"nativeName" : "__GROUP_SCOPE__",
"nativeType" : "string"
},

The value of the GROUP_SCOPE attribute can be global, domain, or universal. If no group scope is set when the group is created, the scope is global by default. For more information about the different group scopes, see the corresponding Microsoft documentation.

The GROUP_TYPE attribute is defined in the provisioner configuration as follows:

...
"__GROUP_TYPE__" : {
"type" : "string",
"nativeName" : "__GROUP_TYPE__",
"nativeType" : "string"
},  

The value of the GROUP_TYPE attribute can be security or distribution. If no group type is set when the group is created, the type is security by default. For more information about the different group types, see the corresponding Microsoft documentation.

The following example creates a new distribution group, with universal scope:

$curl \ --header "Content-Type: application/json" \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ --data '{ "dn": "CN=NewGroup,DC=example,DC=com", "__GROUP_SCOPE__": "universal", "__GROUP_TYPE__": "distribution" }' \ http://localhost:8080/openidm/system/ad/group?_action=create { "_id": "f189df8a-276f-9147-8ad5-055b1580cbcb" } ### 2.4.3. Adding Users to Active Directory Groups With the sample provisioner file, you cannot change the groups of which a user is a member from the user side. Effectively, you can add members to a group but you cannot add groups to a member. (This is also the case if you configure the connector through the Admin UI.) To change this behavior, add the ldapGroups property to the account object in your provisioner file. For example: "ldapGroups" : { "type" : "array", "items" : { "type" : "string", "nativeType" : "string" }, "nativeName" : "ldapGroups", "nativeType" : "string" }, When the connector configuration includes ldapGroups, you can update a user's group membership by patching their user entry. The following command adds user Brian Smith, created previously, to the Employees group: $ curl \
--request PATCH \
--data '[
{
"field": "/ldapGroups/-",
"value": "CN=Employees,DC=example,DC=com"
}
]' \


### 2.4.4. Handling Active Directory Dates

Most dates in Active Directory are represented as the number of 100-nanosecond intervals since January 1, 1601 (UTC). For example:

pwdLastSet: 130698687542272930

IDM generally represents dates as an ISO 8601-compliant string with yyyy-MM-dd'T'HH:mm:ssZ format. For example:

2015-03-02T20:17:48Z

The generic LDAP connector therefore converts any dates from Active Directory to ISO 8601 format, for fields such as pwdLastSet, accountExpires, lockoutTime, and lastLogon.

### 2.4.5. Working with Multiple Active Directory Domains

In a multi-domain Active Directory Domain Services (AD DS) forest, the global catalog (GC) provides a read-only (searchable) representation of every object in the forest. Each domain controller (DC) in the forest stores a writable replica of the objects in its domain. Therefore, a DC can locate only the objects in its domain.

If your Active Directory deployment has only one domain controller, you can configure the connector to connect to that single domain controller. If your deployment spans multiple domains, you must configure the connector to connect to the Global Catalog (GC) to have a comprehensive view of all the domains.

Using a GC as the authoritative data source has the following limitations:

• Only a subset of attributes is replicated from other domains to the GC.

Certain attributes required by the LDAP connector might be missing. To avoid this problem, modify the Active Directory schema to ensure that the required attributes are replicated to the GC.

• Delete operations are not detected immediately.

A liveSync operation will therefore not update IDM with the result of a delete operation. Delete operations are detected by a reconciliation operation, so data stores are only temporarily "out of sync" with regard to deletes.

• Not all group types are supported.

Group membership information is replicated to the GC for universal groups only. You must therefore use universal groups if your directory service has more than one domain.

### Note

You can use the USN value for liveSync but must connect to the GC in this case, and ensure that you never failover to a different GC or to a DC. Using the USN for liveSync instead of the timestamp mechanism is generally preferred, because of the issue with detecting delete operations.

## 2.5. Constructing the LDAP Search Filter

The LDAP connector constructs an LDAP search filter using a combination of filters, in the following order:

(& (native filter) (user filter) (object class filter) )

The filter components are as follows:

Native Filter

The native filter is the query filter that has been translated to an LDAP query. For example, uid+eq+"user123" is translated to uid=user123.

This part of the filter is processed first.

User Filter

You can define a user filter with the properties accountSearchFilter and groupSearchFilter in the connector configuration.

These properties enable you to construct a more granular or specific search filter. If a user filter is specified, the connector does not use the object class filter. If no user filter is specified, (accountSearchFilter and groupSearchFilter set to null or absent from the connector configuration), the connector uses the object class filter.

Object Class Filter

This part of the filter includes the object classes that the entry must have in order to be returned by the search.

The __ACCOUNT__ and __GROUPS__ object classes are defined by the properties accountObjectClasses and groupObjectClasses in the connector configuration. For example, the following excerpt of a sample provisioner.openicf-ldap.json file indicates that the accountObjectClasses include the LDAP object classes top, person, organizationalPerson, and inetOrgPerson:

"configurationProperties" : {
...
"accountObjectClasses" : [
"top",
"person",
"organizationalPerson",
"inetOrgPerson"
]
...

With this configuration, the search filter for accounts is constructed as follows:

(&(objectClass=top)(objectClass=person)(objectClass=organizationalPerson)(objectClass=inetOrgPerson))

If no accountObjectClasses or groupObjectClasses are defined in the connector configuration, the connector uses the name of the ICF ObjectClass in the filter. For example, an object of type organizationUnit will result in:

(&(objectClass=organizationUnit)

## 2.6. OpenICF Interfaces Implemented by the LDAP Connector

The LDAP Connector implements the following OpenICF interfaces.

Provides simple authentication with two parameters, presumed to be a user name and password.

Creates an object and its uid.

Deletes an object, referenced by its uid.

Resolves an object by its username and returns the uid of the object.

Describes the object types, operations, and options that the connector supports.

Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics:

• The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.

• The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration.

• The script has access to any script-arguments passed in by the application.

Searches the target resource for all objects that match the specified object class and filter.

Polls the target resource for synchronization events, that is, native changes to objects on the target resource.

Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.

This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).

You can invoke the test operation before a connector configuration has been validated.

Updates (modifies or replaces) objects on a target resource.

## 2.7. LDAP Connector Configuration

The LDAP Connector has the following configurable properties.

### 2.7.1. Configuration Properties

PropertyTypeDefault Encrypted [a] Required [b]
filterWithOrInsteadOfAnd boolean false
 Sync

Normally the filter used to fetch change log entries is an and-based filter retrieving an interval of change entries. If this property is set, the filter will or together the required change numbers instead.

objectClassesToSynchronize String[] ['inetOrgPerson']
 Sync

The object classes to synchronize. The change log is for all objects; this filters updates to just the listed object classes. You should not list the superclasses of an object class unless you intend to synchronize objects with any of the superclass values. For example, if only "inetOrgPerson" objects should be synchronized, but the superclasses of "inetOrgPerson" ("person", "organizationalperson" and "top") should be filtered out, then list only "inetOrgPerson" here. All objects in LDAP are subclassed from "top". For this reason, you should never list "top", otherwise no object would be filtered.

baseContextsToSynchronize String[] []
 Sync

One or more starting points in the LDAP tree that will be used to determine if a change should be synchronized. The base contexts attribute will be used to synchronize a change if this property is not set.

attributesToSynchronize String[] []
 Sync

The names of the attributes to synchronize. This ignores updates from the change log if they do not update any of the named attributes. For example, if only "department" is listed, then only changes that affect "department" will be processed. All other updates are ignored. If blank (the default), then all changes are processed.

changeNumberAttribute String changeNumber
 Sync

The name of the change number attribute in the change log entry.

modifiersNamesToFilterOut String[] []
 Sync

The list of names (DNs) to filter from the changes. Changes with the attribute "modifiersName" that match entries in this list will be filtered out. The standard value is the administrator name used by this adapter, to prevent loops. Entries should be of the format "cn=Directory Manager".

credentials GuardedString null

changeLogBlockSize int 100
 Sync

The number of change log entries to fetch per query.

useTimestampsForSync boolean false
 Sync

If true, the connector will use the createTimestamp and modifyTimestamp system attributes to detect changes (Create/Update) on the directory instead of native change detection mechanism (cn=changelog on OpenDJ or Update Sequence Number -USN- on Active Directory for instance). Default value is false.

accountSynchronizationFilter String null
 Sync

An optional LDAP filter for the objects to synchronize. Because the change log is for all objects, this filter updates only objects that match the specified filter. If you specify a filter, an object will be synchronized only if it matches the filter and includes a synchronized object class.

removeLogEntryObjectClassFromFilter boolean true
 Sync

If this property is set (the default), the filter used to fetch change log entries does not contain the "changeLogEntry" object class, expecting that there are no entries of other object types in the change log.

alternateKeyStorePassword GuardedString null

Password to use for the alternate keystore

groupSynchronizationFilter String null
 Sync

An optional LDAP filter for the objects to synchronize. Because the change log is for all objects, this filter updates only objects that match the specified filter. If you specify a filter, an object will be synchronized only if it matches the filter and includes a synchronized object class.

groupMemberAttribute String uniqueMember

The name of the group attribute that will be updated with the distinguished name of the user when the user is added to the group.

accountSearchFilter String null

An optional LDAP filter to control which accounts are returned from the LDAP resource. If no filter is specified, only accounts that include all specified object classes are returned.

privateKeyAlias String null

Specifies the name of a private key alias from the keystore that should be used for SSL mutual authentication. If null, no private key is sent during SSL handshake so only server cert is used. This alias name is case sensitive.

ssl boolean false

Select the check box to connect to the LDAP server using SSL.

maintainPosixGroupMembership boolean false

When enabled and a user is renamed or deleted, update any POSIX groups to which the user belongs to reflect the new name. Otherwise, the LDAP resource must maintain referential integrity with respect to group membership.

checkAliveMinInterval long 60

The minimum interval (seconds) at which the target directory is polled when a connection is reused from the pool. Defaults to 60 seconds.

groupSearchFilter String null

An optional LDAP filter to control which groups are returned from the LDAP resource. If no filter is specified, only groups that include all specified object classes are returned.

referralsHandling String follow

Defines how to handle LDAP referrals. Possible values can be follow, ignore or throw.

host String null

The name or IP address of the host where the LDAP server is running.

maintainLdapGroupMembership boolean false

When enabled and a user is renamed or deleted, update any LDAP groups to which the user belongs to reflect the new name. Otherwise, the LDAP resource must maintain referential integrity with respect to group membership.

resetSyncToken String never

Connector can reset the sync token if ever the value of the sync token is greater than the last change number in the directory changelog. Defaults to "never" (no reset). If set to "first" it will reset the sync token to the value of the firstChangeNumber changelog attribute. If set to "last" it will reset the sync token to the value of the lastChangeNumber changelog attribute.

vlvSortAttribute String uid

Specify the sort attribute to use for VLV indexes on the resource.

convertGTToISO8601 String[] ['whenCreated', 'whenChanged']

Converts the Greenwich Time to ISO8601 format

baseContexts String[] []

One or more starting points in the LDAP tree that will be used when searching the tree. Searches are performed when discovering users from the LDAP server or when looking for the groups of which a user is a member.

hostNameVerification boolean false

If true, the connector will verify the hostname in the certificate (subject + alternative subject) against the defined hostNameVerifierPattern.

blockSize int 100

The maximum number of entries that can be in a block when retrieving entries in blocks.

groupObjectClasses String[] ['top', 'groupOfUniqueNames']

The default list of object classes that will be used when creating new group objects in the LDAP tree. This can be overridden by specifying the group object classes during the Create operation.

accountUserNameAttributes String[] ['uid', 'cn']

Attribute or attributes which holds the account's user name. They will be used when authenticating to find the LDAP entry for the user name to authenticate.

failover String[] []

List all servers that should be used for failover in case the preferred server fails. If the preferred server fails, JNDI will connect to the next available server in the list. List all servers in the form of "ldap://ldap.example.com:389/", which follows the standard LDAP v3 URLs described in RFC 2255. Only the host and port parts of the URL are relevant in this setting.

port int 389

TCP/IP port number used to communicate with the LDAP server.

convertADIntervalToISO8601 String[] ['pwdLastSet', 'accountExpires', 'lockoutTime', 'lastLogon']

Converts the AD Interval to ISO8601

hostNameVerifierPattern String null

A simple pattern used to match the hostname from the certificate. It can contains * character (server1.example.com, *.example.com)

passwordAttribute String userPassword

The name of the LDAP attribute that holds the password. When changing a users password, the new password is set to this attribute.

useDNSSRVRecord boolean false

If true, the connector will do a DNS query to find SRV records associated with the value set for host property ("_ldap._tcp.example.com" for example). Defaults to false.

getGroupMemberId boolean false

Specifies whether to add an extra _memberId attribute to get the group members __UID__. CAUTION: Setting this property to true can incur a large performance cost on group handling.

lastCheckAlive long 1605294137139

The last time the connector was checked to see if it was alive

startTLS boolean false

Specifies whether to use the startTLS operation to initiate a TLS/SSL session.

allowTreeDelete boolean false

Connector can delete an entry (node) with leaf entry if this value is set to true (defaults to false). The LDAP control LDAP_SERVER_TREE_DELETE_OID (1.2.840.113556.1.4.805) is used.

respectResourcePasswordPolicyChangeAfterReset boolean false

When this resource is specified in a Login Module (i.e., this resource is a pass-through authentication target) and the resource's password policy is configured for change-after-reset, a user whose resource account password has been administratively reset will be required to change that password after successfully authenticating.

uidAttribute String entryUUID

The name of the LDAP attribute that is mapped to the OpenICF UID attribute.

principal String null

The distinguished name with which to authenticate to the LDAP server.

accountObjectClasses String[] ['top', 'person', 'organizationalPerson', 'inetOrgPerson']

The default list of object classes that will be used when creating new user objects in the LDAP tree. This can be overridden by specifying the user object classes during the Create operation.

alternateKeyStoreType String null

Defines the type of the alternate key store. Valid values are JKS, JCEKS and PKCS12

passwordHashAlgorithm String null

Indicates the algorithm that the Identity system should use to hash the password. Currently supported values are SSHA, SHA, SMD5, MD5 and WIN-AD (when AD is the target). A blank value indicates that the system will not hash passwords. This will cause clear text passwords to be stored in LDAP unless the LDAP server performs the hash (as Forgerocks OpenDJ does, for example).

alternateKeyStore String null

Defines the filename of an alternate keystore. If specified, the connector will not use the default keystore specified by the javax.net.ssl.keyStore property.

authType String simple

The authentication mechanism to use: Simple or SASL-GSSAPI. Defaults to "simple".

connectionTimeout int 30000

The timeout (in ms) before the connection attempt is aborted.

useBlocks boolean false

Specifies whether to use block-based LDAP controls, like the simple paged results or VLV control. When performing search operations on large numbers of entries, the entries are returned in blocks to reduce the amount of memory used by the operation.

readSchema boolean true

If true, the connector will read the schema from the server. If false, the connector will provide a default schema based on the object classes in the configuration. This property must be true in order to use extended object classes.

usePagedResultControl boolean false

When enabled, the LDAP Paged Results control is preferred over the VLV control when retrieving entries.

useOldADGUIDFormat boolean false

The connector used to transform the AD ObjectGUID in the form <GUID=xxxxxx>. It now used dashed notation (xxxx-xx-xx-xxxx-xxxxxx) by default. Set to true to keep the old format.

sendCAUDTxId boolean false

Connector can send the Common Audit Transaction Id (if present) to the target OpenDJ server when this value is set to true (defaults to false). The LDAP control TransactionIdControl (1.3.6.1.4.1.36733.2.1.5.1) is used.

gssapiLoginContext String null

Defines the name used in the JAAS configuration file to define the JAAS login configuration. If null, it defaults to "org.identityconnectors.ldap.LdapConnector".

[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM.

[b] A list of operations in this column indicates that the property is required for those operations.

# Chapter 3. CSV File Connector

The CSV file connector is useful when importing users, either for initial provisioning or for ongoing updates. When used continuously in production, a CSV file serves as a change log, often containing only user records that have changed.

## 3.1. Configuring the CSV File Connector

A sample CSV file connector configuration is provided in openidm/samples/example-configurations/provisioners/provisioner.openicf-csvfile.json.

The following example shows an excerpt of the provisioner configuration. The connectorHostRef property is optional and must be provided only if the connector runs remotely.

{
"connectorRef": {
"connectorHostRef": "#LOCAL",
"connectorName": "org.forgerock.openicf.csvfile.CSVFileConnector",
"bundleName": "org.forgerock.openicf.connectors.csvfile-connector",
"bundleVersion": "[1.5.19.0,1.6.0.0)"
}
}

The only required configuration property is the path to the csvFile:

"configurationProperties" : {
"csvFile" : "&{idm.instance.dir}/data/csvConnectorData.csv"
},

For a list of all configuration properties for this connector, see "Configuration Properties".

### Important

If you change the structure of the CSV file resource, by adding or removing columns, you must update the corresponding object properties in the provisioner file accordingly.

## 3.2. OpenICF Interfaces Implemented by the CSV File Connector

The CSV File Connector implements the following OpenICF interfaces.

Provides simple authentication with two parameters, presumed to be a user name and password.

Execute a series of operations in a single request.

Creates an object and its uid.

Deletes an object, referenced by its uid.

Resolves an object by its username and returns the uid of the object.

Describes the object types, operations, and options that the connector supports.

Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics:

• The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.

• The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration.

• The script has access to any script-arguments passed in by the application.

Searches the target resource for all objects that match the specified object class and filter.

Polls the target resource for synchronization events, that is, native changes to objects on the target resource.

Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.

This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).

You can invoke the test operation before a connector configuration has been validated.

Updates (modifies or replaces) objects on a target resource.

## 3.3. CSV File Connector Configuration

The CSV File Connector has the following configurable properties.

### 3.3.1. Configuration Properties

PropertyTypeDefault Encrypted [a] Required [b]
headerPassword String password

The CSV header that maps to the password for each row. Use this property when password-based authentication is required.

spaceReplacementString String _

The character(s) used to replace spaces within column names.

csvFile File null

The full path to the CSV file that is the data source for this connector.

newlineString String \n

The character string in the CSV file that is used to terminate each line.

headerUid String uid

The CSV header that maps to the uid (or name) for each row.

quoteCharacter String "

The character in the CSV file that is used to encapsulate strings.

fieldDelimiter String ,

The character in the CSV file that is used to separate field values.

syncFileRetentionCount int 3

The number of historical copies of the CSV file to retain when performing synchronization operations.

[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM.

[b] A list of operations in this column indicates that the property is required for those operations.

# Chapter 4. Database Table Connector

The Database Table connector enables provisioning to a single table in a JDBC database.

## 4.1. Configuring the Database Table Connector

A sample connector configuration for the Database Table connector is provided in samples/example-configurations/provisioners/provisioner.openicf-contractordb.json. The corresponding data definition language file is provided in samples/example-configurations/provisioners/provisioner.openicf-contractordb.sql.

The following excerpt shows the settings for the connector configuration properties in the sample Database Table connector:

"configurationProperties" :
{
"quoting" : "",
"host" : "localhost",
"port" : "3306",
"user" : "root",
"database" : "contractordb",
"table" : "people",
"keyColumn" : "UNIQUE_ID",
"jdbcDriver" : "com.mysql.jdbc.Driver",
"jdbcUrlTemplate" : "jdbc:mysql://%h:%p/%d",
"enableEmptyString" : false,
"rethrowAllSQLExceptions" : true,
"nativeTimestamps" : true,
"allNative" : false,
"validConnectionQuery" : null,
"changeLogColumn" : "CHANGE_TIMESTAMP",
"datasource" : "",
"jndiProperties" : null
},

The mandatory configurable properties are as follows:

database

The JDBC database that contains the table to which you are provisioning.

table

The name of the table in the JDBC database that contains the user accounts.

keyColumn

The column value that is used as the unique identifier for rows in the table.

## 4.2. Implementation Specifics

• To use this connector for liveSync, add a changelog type column to the database and provide the name of this column in the changeLogColumn property. Note that the Database Table connector supports liveSync for create and update operations only. To detect deletes in the database you must run a full reconciliation.

• For PATCH requests, a connector can potentially add, remove, or replace an attribute value. The Database Table connector does not implement the add or remove operations, so a PATCH request always replaces the entire attribute value with the new value.

• The Database Table connector supports paged reconciliation queries only for the following databases:

• MySQL

• PostgreSQL

• Oracle Database 12c and later versions

• Microsoft SQL Server 2012 and later versions

### Important

Paging is enabled by default. If you are connecting to a database for which paging is not supported, you must disable it by setting "disablePaging" : true in the connector configuration.

For more information about configuring paged reconciliation queries, see "Paging Reconciliation Query Results" in the Integrator's Guide.

## 4.3. OpenICF Interfaces Implemented by the Database Table Connector

The Database Table Connector implements the following OpenICF interfaces.

Provides simple authentication with two parameters, presumed to be a user name and password.

Creates an object and its uid.

Deletes an object, referenced by its uid.

Resolves an object by its username and returns the uid of the object.

Describes the object types, operations, and options that the connector supports.

Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics:

• The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.

• The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration.

• The script has access to any script-arguments passed in by the application.

Searches the target resource for all objects that match the specified object class and filter.

Polls the target resource for synchronization events, that is, native changes to objects on the target resource.

Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.

This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).

You can invoke the test operation before a connector configuration has been validated.

Updates (modifies or replaces) objects on a target resource.

## 4.4. Database Table Connector Configuration

The Database Table Connector has the following configurable properties.

### 4.4.1. Configuration Properties

PropertyTypeDefault Encrypted [a] Required [b]
connectionProperties String null

The connection properties that will be sent to our JDBC driver when establishing new connections. Format of the string must be [propertyName=property;]* NOTE - The "user" and "password" properties will be passed explicitly, so they do not need to be included here. The default value is null.

propagateInterruptState boolean false

Set this to true to propagate the interrupt state for a thread that has been interrupted (not clearing the interrupt state). Default value is false for backwards compatibility.

useDisposableConnectionFacade boolean true

Set this to true if you wish to put a facade on your connection so that it cannot be reused after it has been closed. This prevents a thread holding on to a reference of a connection it has already called closed on, to execute queries on it.

defaultCatalog String null

The default catalog of connections created by this pool.

validationInterval long 3000

avoid excess validation, only run validation at most at this frequency - time in milliseconds. If a connection is due for validation, but has been validated previously within this interval, it will not be validated again. The default value is 30000 (30 seconds).

ignoreExceptionOnPreLoad boolean false

Flag whether ignore error of connection creation while initializing the pool. Set to true if you want to ignore error of connection creation while initializing the pool. Set to false if you want to fail the initialization of the pool by throwing exception.

jmxEnabled boolean true

Register the pool with JMX or not. The default value is true.

commitOnReturn boolean false

If autoCommit==false then the pool can complete the transaction by calling commit on the connection as it is returned to the pool If rollbackOnReturn==true then this attribute is ignored. Default value is false.

logAbandoned boolean false

Flag to log stack traces for application code which abandoned a Connection. Logging of abandoned Connections adds overhead for every Connection borrow because a stack trace has to be generated. The default value is false.

maxIdle int 100

The maximum number of connections that should be kept in the pool at all times. Default value is maxActive:100 Idle connections are checked periodically (if enabled) and connections that been idle for longer than minEvictableIdleTimeMillis will be released. (also see testWhileIdle)

testWhileIdle boolean false

The indication of whether objects will be validated by the idle object evictor (if any). If an object fails to validate, it will be dropped from the pool. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. The default value is false and this property has to be set in order for the pool cleaner/test thread is to run (also see timeBetweenEvictionRunsMillis)

removeAbandoned boolean false

Flag to remove abandoned connections if they exceed the removeAbandonedTimeout. If set to true a connection is considered abandoned and eligible for removal if it has been in use longer than the removeAbandonedTimeout Setting this to true can recover db connections from applications that fail to close a connection. See also logAbandoned The default value is false.

abandonWhenPercentageFull int 0

Connections that have been abandoned (timed out) wont get closed and reported up unless the number of connections in use are above the percentage defined by abandonWhenPercentageFull. The value should be between 0-100. The default value is 0, which implies that connections are eligible for closure as soon as removeAbandonedTimeout has been reached.

minIdle int 10

The minimum number of established connections that should be kept in the pool at all times. The connection pool can shrink below this number if validation queries fail. Default value is derived from initialSize:10 (also see testWhileIdle)

defaultReadOnly Boolean null

The default read-only state of connections created by this pool. If not set then the setReadOnly method will not be called. (Some drivers dont support read only mode, ex: Informix)

maxWait int 30000

The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. Default value is 30000 (30 seconds)

logValidationErrors boolean false

Set this to true to log errors during the validation phase to the log file. If set to true, errors will be logged as SEVERE. Default value is false for backwards compatibility.

driverClassName String null

The fully qualified Java class name of the JDBC driver to be used. The driver has to be accessible from the same classloader as tomcat-jdbc.jar

name String Tomcat Connection Pool[3-340884009]

Returns the name of the connection pool. By default a JVM unique random name is assigned.

useStatementFacade boolean true

Returns true if this connection pool is configured to wrap statements in order to enable equals() and hashCode() methods to be called on the closed statements if any statement proxy is set.

initSQL String null

A custom query to be run when a connection is first created. The default value is null.

validationQueryTimeout int -1

The timeout in seconds before a connection validation queries fail. This works by calling java.test_sample.Statement.setQueryTimeout(seconds) on the statement that executes the validationQuery. The pool itself doesnt timeout the query, it is still up to the JDBC driver to enforce query timeouts. A value less than or equal to zero will disable this feature. The default value is -1.

validationQuery String null

The SQL query that will be used to validate connections from this pool before returning them to the caller. If specified, this query does not have to return any data, it just cant throw a SQLException. The default value is null. Example values are SELECT 1(mysql), select 1 from dual(oracle), SELECT 1(MS Sql Server)

rollbackOnReturn boolean false

If autoCommit==false then the pool can terminate the transaction by calling rollback on the connection as it is returned to the pool Default value is false.

alternateUsernameAllowed boolean false

By default, the jdbc-pool will ignore the DataSource.getConnection(username,password) call, and simply return a previously pooled connection under the globally configured properties username and password, for performance reasons. The pool can however be configured to allow use of different credentials each time a connection is requested. To enable the functionality described in the DataSource.getConnection(username,password) call, simply set the property alternateUsernameAllowed to true. Should you request a connection with the credentials user1/password1 and the connection was previously connected using different user2/password2, the connection will be closed, and reopened with the requested credentials. This way, the pool size is still managed on a global level, and not on a per schema level.

validatorClassName String null

The name of a class which implements the org.apache.tomcat.jdbc.pool.Validator interface and provides a no-arg constructor (may be implicit). If specified, the class will be used to create a Validator instance which is then used instead of any validation query to validate connections. The default value is null. An example value is com.mycompany.project.SimpleValidator.

suspectTimeout int 0

Timeout value in seconds. Similar to to the removeAbandonedTimeout value but instead of treating the connection as abandoned, and potentially closing the connection, this simply logs the warning if logAbandoned is set to true. If this value is equal or less than 0, no suspect checking will be performed. Suspect checking only takes place if the timeout value is larger than 0 and the connection was not abandoned or if abandon check is disabled. If a connection is suspect a WARN message gets logged and a JMX notification gets sent once.

useEquals boolean true

Set to true if you wish the ProxyConnection class to use String.equals and set to false when you wish to use == when comparing method names. This property does not apply to added interceptors as those are configured individually. The default value is true.

removeAbandonedTimeout int 60

Timeout in seconds before an abandoned(in use) connection can be removed. The default value is 60 (60 seconds). The value should be set to the longest running query your applications might have.

defaultAutoCommit Boolean null

The default auto-commit state of connections created by this pool. If not set, default is JDBC driver default (If not set then the setAutoCommit method will not be called.)

testOnConnect boolean false

Returns true if we should run the validation query when connecting to the database for the first time on a connection. Normally this is always set to false, unless one wants to use the validationQuery as an init query.

jdbcInterceptors String null

A semicolon separated list of classnames extending org.apache.tomcat.jdbc.pool.JdbcInterceptor class. See Configuring JDBC interceptors below for more detailed description of syntaz and examples. These interceptors will be inserted as an interceptor into the chain of operations on a java.test_sample.Connection object. The default value is null.

initialSize int 10

The initial number of connections that are created when the pool is started. Default value is 10

defaultTransactionIsolation int -1

The default TransactionIsolation state of connections created by this pool. One of the following: NONE, READ_COMMITTED, READ_UNCOMMITTED, REPEATABLE_READ, SERIALIZABLE If not set, the method will not be called and it defaults to the JDBC driver.

numTestsPerEvictionRun int 0

Property not used in tomcat-jdbc-pool.

url String null

The URL used to connect to the database.

testOnBorrow boolean false

The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. In order to have a more efficient validation, see validationInterval. Default value is false

fairQueue boolean true

Set to true if you wish that calls to getConnection should be treated fairly in a true FIFO fashion. This uses the org.apache.tomcat.jdbc.pool.FairBlockingQueue implementation for the list of the idle connections. The default value is true. This flag is required when you want to use asynchronous connection retrieval. Setting this flag ensures that threads receive connections in the order they arrive. During performance tests, there is a very large difference in how locks and lock waiting is implemented. When fairQueue=true there is a decision making process based on what operating system the system is running. If the system is running on Linux (property os.name=Linux. To disable this Linux specific behavior and still use the fair queue, simply add the property org.apache.tomcat.jdbc.pool.FairBlockingQueue.ignoreOS=true to your system properties before the connection pool classes are loaded.

accessToUnderlyingConnectionAllowed boolean true

Property not used. Access can be achieved by calling unwrap on the pooled connection. see javax.test_sample.DataSource interface, or call getConnection through reflection or cast the object as javax.test_sample.PooledConnection

maxAge long 0

Time in milliseconds to keep this connection. When a connection is returned to the pool, the pool will check to see if the now - time-when-connected > maxAge has been reached, and if so, it closes the connection rather than returning it to the pool. The default value is 0, which implies that connections will be left open and no age check will be done upon returning the connection to the pool.

minEvictableIdleTimeMillis int 60000

The minimum amount of time an object may sit idle in the pool before it is eligible for eviction. The default value is 60000 (60 seconds).

timeBetweenEvictionRunsMillis int 5000

The number of milliseconds to sleep between runs of the idle connection validation/cleaner thread. This value should not be set under 1 second. It dictates how often we check for idle, abandoned connections, and how often we validate idle connections. The default value is 5000 (5 seconds).

testOnReturn boolean false

The indication of whether objects will be validated before being returned to the pool. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. The default value is false.

useLock boolean false

Return true if a lock should be used when operations are performed on the connection object. Should be set to false unless you plan to have a background thread of your own doing idle and abandon checking such as JMX clients. If the pool sweeper is enabled, then the lock will automatically be used regardless of this setting.

maxActive int 100

The maximum number of active connections that can be allocated from this pool at the same time. The default value is 100

username String null

The connection username to be passed to our JDBC driver to establish a connection. Note that method DataSource.getConnection(username,password) by default will not use credentials passed into the method, but will use the ones configured here. See alternateUsernameAllowed property for more details.

table String TABLE_NAME

Enter the name of the table in the database that contains the accounts.

[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM.

[b] A list of operations in this column indicates that the property is required for those operations.

### 4.4.2. Basic Configuration Properties

PropertyTypeDefault Encrypted [a] Required [b]
password String null

The connection password to be passed to the JDBC driver to establish a connection. Note that method DataSource.getConnection(username,password) by default will not use credentials passed into the method, but will use the ones configured here. See alternateUsernameAllowed property for more details.

quoting String NONE

Select whether database column names for this resource should be quoted, and the quoting characters. By default, database column names are not quoted (None). For other selections (Single, Double, Back, or Brackets), column names will appear between single quotes, double quotes, back quotes, or brackets in the SQL generated to access the database.

keyColumn String KEY_COLUMN

This mandatory column value will be used as the unique identifier for rows in the table.

passwordColumn String null

Enter the name of the column in the table that will hold the password values. If empty, no validation is done on resources and passwords.

disablePaging boolean false

If true, optional paging in a query will be ignored by the connector. Defaults to false.

enableEmptyString boolean false

Select to enable support for writing an empty string, instead of a NULL value, in character based columns defined as not-null in the table schema. This option does not influence the way strings are written for Oracle based tables. By default empty strings are written as a NULL value.

rethrowAllSQLExceptions boolean true

If this is not checked, SQL statements which throw SQLExceptions with a 0 ErrorCode will be have the exception caught and suppressed. Check it to have exceptions with 0 ErrorCodes rethrown.

nativeTimestamps boolean false

Select to retrieve Timestamp data type of the columns in java.sql.Timestamp format from the database table.

allNative boolean false

Select to retrieve all data types of columns in native format from the database table.

changeLogColumn String null
 Sync

The change log column stores the latest change time. Providing this value the Sync capabilities are activated.

suppressPassword boolean true

If set to true then the password will not be returned. Never. Even though it is explicitly requested. If set to false then the password will be returned if it is explicitly requested.

inclusiveSync boolean false

If true, the SyncOp will query for ChangeLogColumn >= syncToken. One record will always be returned from the database in this case and be handled by the connector. If set to false, the SyncOp will query for ChangeLogColumn > syncToken. Defaults to false.

[a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM.

[b] A list of operations in this column indicates that the property is required for those operations.

# Chapter 5. PowerShell Connector Toolkit

The PowerShell Connector Toolkit is not a complete connector in the traditional sense. Rather, it is a framework within which you must write your own PowerShell scripts to address the requirements of your Microsoft Windows ecosystem. You can use the PowerShell Connector Toolkit to create connectors that can provision any Microsoft system, including, but not limited to, Active Directory, Microsoft SQL, MS Exchange, SharePoint, Azure, and Office365. Essentially, any task that can be performed with PowerShell can be executed through connectors based on this toolkit.

The PowerShell Connector Toolkit is available from the ForgeRock BackStage download site.

IDM includes sample scripts for synchronization of users between Windows Active Directory and IDM. These sample scripts can help you get started with the PowerShell Connector toolkit. For more information, see "Connecting to Active Directory With the PowerShell Connector" in the Samples Guide.

## 5.1. Before You Start

To implement a scripted PowerShell connector, you must install the following:

• Microsoft .NET Framework 4.5 or later. Connectors created with the PowerShell Connector Toolkit run on the .NET platform and require the installation of a .NET connector server on the Windows system. To install the .NET connector server, follow the instructions in "Installing and Configuring a .NET Connector Server" in the Integrator's Guide.

• PowerShell version 4.0 or above.

• The PowerShell Connector Toolkit.

## 5.2. Setting Up the PowerShell Connector

To run the commands in this procedure, start with the PowerShell command line. Some of the commands in this procedure require administrative privileges.

1. Install, configure, and start the .NET connector server on a Windows host. If you are running an Active Directory Domain Controller, install the .NET connector server on the same host on which the Windows PowerShell module is installed.

For instructions on installing the .NET connector server, see "Installing and Configuring a .NET Connector Server" in the Integrator's Guide.

2. Configure IDM to connect to the .NET connector server.

To do so, copy the remote connector provisioner file from the openidm\samples\provisioners directory to your project's conf\ directory, and edit the file to match your configuration.

PS C:\ cd \path\to\openidm
PS C:\path\to\openidm cp samples\example-configurations\provisioners\provisioner.openicf.connectorinfoprovider.json conf

For instructions on editing this file, see "Configuring IDM to Connect to the .NET Connector Server" in the Integrator's Guide.

3. Download the PowerShell Connector Toolkit archive (mspowershell-connector-1.4.5.0.zip) from the ForgeRock BackStage download site.

Extract the archive and move the MsPowerShell.Connector.dll to the folder in which the connector server application executable file (ConnectorServerService.exe) is located.

4. The openidm\samples\scripted-powershell-with-ad directory contains sample scripts for a connection to Active Directory. Copy these scripts to the host on which the .NET connector server is installed.

The full path to the scripts must be referenced in your connector configuration file (provisioner.openicf-*.json), for example:

"CreateScriptFileName" : "C:/openidm/samples/scripted-powershell-with-ad/tools/ADCreate.ps1",
...
5. Copy the sample connector configuration file (provisioner.openicf-adpowershell.json) from the samples\provisioners directory to your project's conf directory.

Verify that at least the path to the scripts and the connection and authentication details are correct for your deployment. The following section describes the configurable properties in the sample connector configuration files.

### Note

Paths in these files must use forward slash characters and not the backslash characters that you would expect in a Windows path.

## 5.3. Configuring the PowerShell Connector

Your PowerShell connector configuration file should include the following properties:

PropertyTypeExampleEncrypted [a] Required [b]
operationScriptFileName String C:/openidm/AD/ADCreate.ps1,

The full path to the script that implements the corresponding OpenICF operation.

VariablesPrefix String Connector

To avoid variable namespace conflicts, you can define a prefix for the connector variables. All variables are injected into the script under that prefix and can be used with the dotted notation.

QueryFilterType String AdPsModule (for Active Directory)

A configurable query filter visitor property that defines the format in which the query will be injected into the connector. Possible values are:

• Map - the query filter is a map

• Ldap - the query filter is in LDAP search format, for example, "(cn=Joe)"

• Native - the query filter is a native OpenICF query filter

• AdPsModule - the query filter is compatible with the Active Directory PowerShell module, Get-ADUser Filter

ReloadScriptOnExecution Boolean true

When true, the connector reloads the script from disk every time it is executed. This can be useful for debugging purposes. Set to false in production.

UseInterpretersPool Boolean true

If true, the connector leverages the PowerShell RunSpace Pool.

MaxInterpretersPoolSize Integer 5

The maximum size of the interpreter pool.

MinInterpretersPoolSize Integer 1

The minimum size of the interpreter pool.

PoolCleanupInterval Double 60

Specifies the interval (in minutes) at which unused interpreter instances are discarded. To avoid cleaning up unused interpreter instances, set this property to 0.

SubstituteUidAndNameInQueryFilter Boolean true

Specifies whether the __UID__ and __NAME__ should be replaced by the value defined in the NameAttributeName and UidAttributeName in the query filter.

UidAttributeName String ObjectGUID

The attribute on the resource that contains the object __UID__

NameAttributeName String DistinguishedName

The attribute on the resource that contains the object __NAME__

PsModulesToImport Array [ "ActiveDirectory", "C:/openidm/samples/scripted-powershell-with-ad/tools/ADSISearch.psm1"],

An array of additional PowerShell modules that the connector must import

Host String ad.example.com

The host name or IP address of the Active Directory server

Port Integer null

The port number on which the remote resource listens for connections

Login String ""

The user account in the remote resource that is used for the connection

Password String null

The password of the user account that is used for the connection

CustomProperties Array [ ]

An array of Strings to define custom configuration properties. Each property takes the format "name=value". For example:

"configurationProperties" : {
...
"CustomProperties" : ["baseContext = CN=Users,DC=example,DC=com" ],
...  },

The custom property can then be read from the PowerShell scripts as follows: $base =$Connector.Configuration.PropertyBag.baseContext

[a] Indicates whether the property value is considered confidential, and therefore encrypted in IDM.

[b] A list of operations in this column indicates that the property is required for those operations.

## 5.4. Testing the PowerShell Connector

Start IDM with the configuration for your PowerShell connector project.

The following tests assume that the configuration is in the default path/to/openidm directory. If your PowerShell project is in a different directory, use the startup command with the -p option to point to that directory.

$cd path/to/openidm$ ./startup.sh

### 5.4.1. Confirming the Connector Configuration

To test that the PowerShell connector has been configured correctly, run the following REST call:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ "http://localhost:8080/openidm/system?_action=test" { "name" : "adpowershell", "enabled" : true, "config" : "config/provisioner.openicf/adpowershell", "objectTypes" : [ "__ALL__", "group", "account" ], "connectorRef" : { "connectorName" : "Org.Forgerock.OpenICF.Connectors.MsPowerShell.MsPowerShellConnector", "bundleName" : "MsPowerShell.Connector", "bundleVersion" : "[1.4.3.0,1.5.0.0)" }, "displayName" : "PowerShell Connector", "ok" : true } When you run this test, you should also see a log entry associated with the .NET connector server, in the logs/ subdirectory of that server. ### 5.4.3. Creating With the Connector You can use the connector to create new users or groups on the target system, based on options listed in the relevant provisioner.openicf-* configuration file. For example, the following command creates a new user in Active Directory: $ curl \
--request POST \
--data '{
"LastName": "Smith",
"PreferredLanguage": "en-US",
"FirstName": "Robert",
"UserPrincipalName": "Robert.Smith@example.onmicrosoft.com",
"DisplayName": "Robert Smith"
}' \
"http://localhost:8080/openidm/system/adpowershell/account?_action=create"

### 5.4.4. Updating With the Connector

The PowerShell scripts associated with update functionality support changes to the following properties:

• Principal Name

• Common user attributes

As an example, you could use the following command to change the password for the user with the noted _id:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request PATCH \ --header "content-type: application/json" \ --data '{ "operation": "replace", "Field": "password", "value": "Passw1rd" }' \ "http://localhost:8080/openidm/system/adpowershell/account/1d4c9276-6937-4d9e-9c60-67e8b4207f4e" ### 5.4.5. Deleting With the Connector You can use the PowerShell connector to delete user and group objects. The following command deletes a user in Active Directory, based on their _id: $ curl \
--request DELETE \
"http://localhost:8080/openidm/system/adpowershell/account/1d4c9276-6937-4d9e-9c60-67e8b4207f4e"

### 5.4.6. Running a Script on the Connector

The runScriptOnConnector script lets you run an arbitrary script action through the connector. This script takes the following variables as input:

Configuration

A handler to the connector's configuration object.

Options

A handler to the Operation Options.

Operation

The operation type that corresponds to the action (RUNSCRIPTONCONNECTOR in this case).

Arguments

A map of script arguments (this can be null).

The script can return any object that can be serialized by OpenICF, such as Boolean, String, Array, or Dictionary. If the object type cannot be serialized, such as Hashtable, the script fails with the error:

"error": "No serializer for class: System.Collections.Hashtable"

To run an arbitrary script on the PowerShell connector, define the script in the systemActions property of your provisioner file:

"systemActions" : [
{
"scriptId" : "MyScript",
"actions" : [
{
"systemType" : ".*PowerShellConnector",
"actionType" : "PowerShell",
"actionFile" : "scripts/Myactionscript.ps1"
}
]
}
]

When you have defined the script, you can call it over REST on the system endpoint, as follows:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ "http://localhost:8080/openidm/system/adpowershell?_action=script&scriptId=MyScript&param1=value1&param2=value2" You can also call it through the IDM script engine, as follows: openidm.action("/system/adpowershell","script", {}, {"scriptId": "MyScript", "param1": "value1", "param2": "value2"}) ### Important Because the action script is stored locally with IDM, it must be transmitted across the network every time it is called. An alternative approach is to write a PowerShell module and to load it using the PsModulesToImport option of the PowerShell connector. In this case, the action script is limited to a function call and you do not need a script file on the IDM side. The following example uses the actionSource property in the provisioner, instead of the actionFile property, to call the action. The example calls a custom Set-Exchange function from a module loaded on the .Net connector server by the PowerShell connector: "systemActions" : [ { "scriptId" : "SetExchange", "actions" : [ { "systemType" : ".*PowerShellConnector", "actionType" : "PowerShell", "actionSource" : "Set-Exchange$Connector.Arguments.dn"
}
]
}
]

# Chapter 6. Groovy Connector Toolkit

ICF provides a generic Groovy Connector Toolkit that lets you run a Groovy script for any ICF operation, such as search, update, create, and others, on any external resource.

The Groovy Connector Toolkit is not a complete connector in the traditional sense. Rather, it is a framework within which you must write your own Groovy scripts to address the requirements of your implementation.

## 6.1. Configuring Scripted Groovy Connectors

The Groovy Connector Toolkit is bundled in the JAR openidm/connectors/groovy-connector-1.5.19.1.jar.

The Samples Guide describes a number of scripted connector implementations. The scripts provided with these samples demonstrate how the Groovy Connector Toolkit can be used. These scripts cannot be used as is in your deployment, but are a good starting point on which to base your customization. For information about writing your own scripts, see "Writing Scripted Connectors With the Groovy Connector Toolkit" in the Connector Developer's Guide.

You specify the connector configuration in your project's conf/provisioner.openicf-connector.json file. A number of sample configurations for scripted Groovy implementations are provided in openidm/samples/example-configurations/provisioners/provisioner.openicf-scriptedimpementation.json. Use these as the basis for configuring your own scripted connector.

### 6.1.1. Validating Pooled Connections

The scripted SQL connector uses the Tomcat JDBC Connection Pool to managed its connections. Occasionally, a JDBC resource that is accessed by the scripted SQL connector might become unavailable for a period. When the resource comes back online, IDM is generally able to recover automatically and resume operations. However, the connector might not be able to refresh its connection pool and might then pass a closed connection to its scripts. This can affect operations until IDM is restarted.

To avoid this situation, you can configure connection validation, where connections are validated before being borrowed from the connection pool.

To configure connection validation, add the following properties to the configurationProperties object in your connector configuration:

testOnBorrow

Validates the connection object before it is borrowed from the pool. If the object fails to validate, it is dropped from the pool and the connector attempts to borrow another object.

For this property to have an effect, you must set validationQuery to a non-null string.

validationQuery

The SQL query used to validate connections from the pool before returning them to the caller.

The precise query will differ, depending on the database that you are accessing. The following list provides sample queries for common databases:

HyperSQL DataBase (HSQLDB)
select 1 from INFORMATION_SCHEMA.SYSTEM_USERS
Oracle DB
select 1 from dual
DB2
select 1 from sysibm.sysdummy1
MySQL
select 1
Microsoft SQL
select 1
PostgreSQL
select 1
Ingres Database
select 1
Apache Derby
values 1
H2 Database
select 1
Firebird SQL
select 1 from rdb$database validationInterval Specifies the maximum frequency (in milliseconds) at which validation is run. If a connection is due for validation but was previously validated within this interval, it is not validated again. The larger this value, the better the connector performance. However, with a large value you increase the chance of a stale connection being presented to the connector. Connection validation can have an impact on performance and should not be done too frequently. With the following configuration, connections are validated no more than every 34 seconds: { ... "configurationProperties" : { ... "testOnBorrow" : true, "validationQuery" : "select 1 from dual", "validationInterval" : 34000,  ### 6.1.2. Using Custom Properties The customConfiguration and customSensitiveConfiguration properties enable you to inject custom properties into your scripts. Properties listed in customSensitiveConfiguration are encrypted. For example, the following excerpt of the scripted Kerberos provisioner file shows how these properties inject the Kerberos user and encrypted password into the scripts, using the kadmin command. "customConfiguration" : "kadmin { cmd = '/usr/sbin/kadmin.local'; user='<KADMIN USERNAME>'; default_realm='<REALM>' }", "customSensitiveConfiguration" : "kadmin { password = '<KADMIN PASSWORD>'}",  ## 6.2. Implemented Interfaces The following tables list the ICF interfaces that are implemented for non-poolable and poolable connector implementations: ### 6.2.1. OpenICF Interfaces Implemented by the Scripted Groovy Connector The Scripted Groovy Connector implements the following OpenICF interfaces. Provides simple authentication with two parameters, presumed to be a user name and password. Creates an object and its uid. Deletes an object, referenced by its uid. Resolves an object by its username and returns the uid of the object. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Runs a script on the target resource that is managed by this connector. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ### 6.2.2. OpenICF Interfaces Implemented by the Scripted Poolable Groovy Connector The Scripted Poolable Groovy Connector implements the following OpenICF interfaces. Provides simple authentication with two parameters, presumed to be a user name and password. Creates an object and its uid. Deletes an object, referenced by its uid. Resolves an object by its username and returns the uid of the object. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Runs a script on the target resource that is managed by this connector. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 6.3. Configuration Properties The following tables list the configuration properties for non-poolable and poolable connector implementations: ### 6.3.1. Scripted Groovy Connector Configuration The Scripted Groovy Connector has the following configurable properties. #### 6.3.1.1. Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] customSensitiveConfiguration GuardedString null Custom Sensitive Configuration script for Groovy ConfigSlurper customConfiguration String null Custom Configuration script for Groovy ConfigSlurper [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 6.3.1.2. Operation Script Files Properties PropertyTypeDefault Encrypted [a] Required [b] createScriptFileName String null  Create The name of the file used to perform the CREATE operation. customizerScriptFileName String null The script used to customize some function of the connector. Read the documentation for more details. authenticateScriptFileName String null  Authenticate The name of the file used to perform the AUTHENTICATE operation. scriptOnResourceScriptFileName String null  Script On Resource The name of the file used to perform the RUNSCRIPTONRESOURCE operation. deleteScriptFileName String null  Delete The name of the file used to perform the DELETE operation. resolveUsernameScriptFileName String null  Resolve Username The name of the file used to perform the RESOLVE_USERNAME operation. searchScriptFileName String null  Get Search The name of the file used to perform the SEARCH operation. updateScriptFileName String null  Update The name of the file used to perform the UPDATE operation. schemaScriptFileName String null  Schema The name of the file used to perform the SCHEMA operation. testScriptFileName String null  Test The name of the file used to perform the TEST operation. syncScriptFileName String null  Sync The name of the file used to perform the SYNC operation. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 6.3.1.3. Groovy Engine configuration Properties PropertyTypeDefault Encrypted [a] Required [b] targetDirectory File null Directory into which to write classes. warningLevel int 1 Warning Level of the compiler scriptExtensions String[] ['groovy'] Gets the extensions used to find groovy files minimumRecompilationInterval int 100 Sets the minimum of time after a script can be recompiled. scriptBaseClass String null Base class name for scripts (must derive from Script) scriptRoots String[] null The root folder to load the scripts from. If the value is null or empty the classpath value is used. tolerance int 10 The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. debug boolean false If true, debugging code should be activated classpath String[] [] Classpath for use during compilation. disabledGlobalASTTransformations String[] null Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. verbose boolean false If true, the compiler should produce action information sourceEncoding String UTF-8 Encoding for source files recompileGroovySource boolean false If set to true recompilation is enabled [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 6.3.2. Scripted Poolable Groovy Connector Configuration The Scripted Poolable Groovy Connector has the following configurable properties. #### 6.3.2.1. Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] customSensitiveConfiguration GuardedString null Custom Sensitive Configuration script for Groovy ConfigSlurper customConfiguration String null Custom Configuration script for Groovy ConfigSlurper [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 6.3.2.2. Operation Script Files Properties PropertyTypeDefault Encrypted [a] Required [b] createScriptFileName String null  Create The name of the file used to perform the CREATE operation. customizerScriptFileName String null The script used to customize some function of the connector. Read the documentation for more details. authenticateScriptFileName String null  Authenticate The name of the file used to perform the AUTHENTICATE operation. scriptOnResourceScriptFileName String null  Script On Resource The name of the file used to perform the RUNSCRIPTONRESOURCE operation. deleteScriptFileName String null  Delete The name of the file used to perform the DELETE operation. resolveUsernameScriptFileName String null  Resolve Username The name of the file used to perform the RESOLVE_USERNAME operation. searchScriptFileName String null  Get Search The name of the file used to perform the SEARCH operation. updateScriptFileName String null  Update The name of the file used to perform the UPDATE operation. schemaScriptFileName String null  Schema The name of the file used to perform the SCHEMA operation. testScriptFileName String null  Test The name of the file used to perform the TEST operation. syncScriptFileName String null  Sync The name of the file used to perform the SYNC operation. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 6.3.2.3. Groovy Engine configuration Properties PropertyTypeDefault Encrypted [a] Required [b] targetDirectory File null Directory into which to write classes. warningLevel int 1 Warning Level of the compiler scriptExtensions String[] ['groovy'] Gets the extensions used to find groovy files minimumRecompilationInterval int 100 Sets the minimum of time after a script can be recompiled. scriptBaseClass String null Base class name for scripts (must derive from Script) scriptRoots String[] null The root folder to load the scripts from. If the value is null or empty the classpath value is used. tolerance int 10 The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. debug boolean false If true, debugging code should be activated classpath String[] [] Classpath for use during compilation. disabledGlobalASTTransformations String[] null Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. verbose boolean false If true, the compiler should produce action information sourceEncoding String UTF-8 Encoding for source files recompileGroovySource boolean false If set to true recompilation is enabled [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ## 6.4. Debugging Scripts Called From the Groovy Connector When you call a Groovy script from the Groovy connector, you can use the SLF4J logging facility to obtain debug information. For instructions on how to use this facility, see the KnowledgeBase article How do I add logging to Groovy scripts in IDM. # Chapter 7. Scripted REST Connector The Scripted REST connector is an implementation of the Scripted Groovy Connector Toolkit. This connector lets you interact with any REST API, using Groovy scripts for the ICF operations. ### Note The Scripted REST connector is not a poolable connector. ## 7.1. Configuring the Scripted REST Connector The Scripted REST Connector is bundled in the JAR openidm/connectors/scriptedrest-connector-1.5.19.1.jar. A sample connector configuration and scripts are provided in the /path/to/openidm/samples/scripted-rest-with-dj/ directory and described in "Connecting to DS With ScriptedREST" in the Samples Guide. The scripts provided with this sample demonstrate how the connector can be used but most likely cannot be used as is in your deployment. They are a good starting point on which to base your customization. For information about writing your own scripts, see "Writing Scripted Connectors With the Groovy Connector Toolkit" in the Connector Developer's Guide. ## 7.2. Using the Scripted REST Connector With a Proxy Server If the IDM server is hosted behind a firewall and requests to the resource are routed through a proxy, you must specify the proxy host and port in the connector configuration. To specify the proxy server details, set the proxyAddress property in the connector configuration. For example: "configurationProperties": { ... "proxyAddress": "http://myproxy:8080", ... },  ## 7.3. Implemented Interfaces The following table lists the ICF interfaces that are implemented for the scripted REST connector: ### 7.3.1. OpenICF Interfaces Implemented by the Scripted REST Connector The Scripted REST Connector implements the following OpenICF interfaces. Provides simple authentication with two parameters, presumed to be a user name and password. Creates an object and its uid. Deletes an object, referenced by its uid. Resolves an object by its username and returns the uid of the object. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Runs a script on the target resource that is managed by this connector. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 7.4. Configuration Properties The following table lists the configuration properties for the scripted REST connector: ### 7.4.1. Scripted REST Connector Configuration The Scripted REST Connector has the following configurable properties. #### 7.4.1.1. Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] customSensitiveConfiguration GuardedString null Custom Sensitive Configuration script for Groovy ConfigSlurper customConfiguration String null Custom Configuration script for Groovy ConfigSlurper [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 7.4.1.2. Operation Script Files Properties PropertyTypeDefault Encrypted [a] Required [b] createScriptFileName String null  Create The name of the file used to perform the CREATE operation. customizerScriptFileName String null The script used to customize some function of the connector. Read the documentation for more details. authenticateScriptFileName String null  Authenticate The name of the file used to perform the AUTHENTICATE operation. scriptOnResourceScriptFileName String null  Script On Resource The name of the file used to perform the RUNSCRIPTONRESOURCE operation. deleteScriptFileName String null  Delete The name of the file used to perform the DELETE operation. resolveUsernameScriptFileName String null  Resolve Username The name of the file used to perform the RESOLVE_USERNAME operation. searchScriptFileName String null  Get Search The name of the file used to perform the SEARCH operation. updateScriptFileName String null  Update The name of the file used to perform the UPDATE operation. schemaScriptFileName String null  Schema The name of the file used to perform the SCHEMA operation. testScriptFileName String null  Test The name of the file used to perform the TEST operation. syncScriptFileName String null  Sync The name of the file used to perform the SYNC operation. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 7.4.1.3. Groovy Engine configuration Properties PropertyTypeDefault Encrypted [a] Required [b] targetDirectory File null Directory into which to write classes. warningLevel int 1 Warning Level of the compiler scriptExtensions String[] ['groovy'] Gets the extensions used to find groovy files minimumRecompilationInterval int 100 Sets the minimum of time after a script can be recompiled. scriptBaseClass String null Base class name for scripts (must derive from Script) scriptRoots String[] null The root folder to load the scripts from. If the value is null or empty the classpath value is used. tolerance int 10 The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. debug boolean false If true, debugging code should be activated classpath String[] [] Classpath for use during compilation. disabledGlobalASTTransformations String[] null Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. verbose boolean false If true, the compiler should produce action information sourceEncoding String UTF-8 Encoding for source files recompileGroovySource boolean false If set to true recompilation is enabled [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 7.4.1.4. Basic Configuration Properties Properties PropertyTypeDefault Encrypted [a] Required [b] username String null The Remote user to authenticate with password GuardedString null The Password to authenticate with serviceAddress URI null The service URI (example: http://myservice.com/api) proxyAddress URI null The optional Proxy server URI (example: http://myproxy:8080) defaultAuthMethod String BASIC Athentication method used. Defaults to BASIC. defaultContentType String application/json Default HTTP request content type. Defaults to JSON. Can be: TEXT, XML, HTML, URLENC, BINARY defaultRequestHeaders String[] null Placeholder for default HTTP request headers. OAuthTokenEndpoint URI null When using OAUTH, this property defines the endpoint where a new access token should be queried for (https://myserver.com/oauth2/token) OAuthClientId String null The client identifier OAuthClientSecret GuardedString null Secure client secret for OAUTH OAuthRefreshToken GuardedString null The refresh token used to renew the access token for the refresh_token grant type OAuthScope String null The optional scope OAuthGrantType String CLIENT_CREDENTIALS The grant type to use. Can be CLIENT_CREDENTIALS (default) | REFRESH_TOKEN | AUTHORIZATION_CODE [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. # Chapter 8. Scripted SQL Connector The Scripted SQL connector is an implementation of the Scripted Groovy Connector Toolkit. This connector lets you interact with any SQL database, using Groovy scripts for the ICF operations. ## 8.1. Configuring the Scripted SQL Connector The Scripted SQL Connector is bundled in the JAR openidm/connectors/scriptedsql-connector-1.5.19.1.jar. A sample connector configuration and scripts are provided in the /path/to/openidm/samples/scripted-sql-with-mysql/ directory and described in "Connecting to a MySQL Database With ScriptedSQL" in the Samples Guide. The scripts provided with this sample demonstrate how the connector can be used but most likely cannot be used as is in your deployment. They are a good starting point on which to base your customization. For information about writing your own scripts, see "Writing Scripted Connectors With the Groovy Connector Toolkit" in the Connector Developer's Guide. ## 8.2. Implemented Interfaces The following table lists the ICF interfaces that are implemented for the scripted SQL connector: ### 8.2.1. OpenICF Interfaces Implemented by the Scripted SQL Connector The Scripted SQL Connector implements the following OpenICF interfaces. Provides simple authentication with two parameters, presumed to be a user name and password. Creates an object and its uid. Deletes an object, referenced by its uid. Resolves an object by its username and returns the uid of the object. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Runs a script on the target resource that is managed by this connector. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 8.3. Configuration Properties The following table lists the configuration properties for the scripted SQL connector: ### 8.3.1. Scripted SQL Connector Configuration The Scripted SQL Connector has the following configurable properties. #### 8.3.1.1. Operation Script Files Properties PropertyTypeDefault Encrypted [a] Required [b] createScriptFileName String null  Create The name of the file used to perform the CREATE operation. customizerScriptFileName String null The script used to customize some function of the connector. Read the documentation for more details. resolveUsernameScriptFileName String null  Resolve Username The name of the file used to perform the RESOLVE_USERNAME operation. updateScriptFileName String null  Update The name of the file used to perform the UPDATE operation. schemaScriptFileName String null  Schema The name of the file used to perform the SCHEMA operation. authenticateScriptFileName String null  Authenticate The name of the file used to perform the AUTHENTICATE operation. scriptOnResourceScriptFileName String null  Script On Resource The name of the file used to perform the RUNSCRIPTONRESOURCE operation. deleteScriptFileName String null  Delete The name of the file used to perform the DELETE operation. searchScriptFileName String null  Get Search The name of the file used to perform the SEARCH operation. testScriptFileName String null  Test The name of the file used to perform the TEST operation. syncScriptFileName String null  Sync The name of the file used to perform the SYNC operation. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 8.3.1.2. Groovy Engine configuration Properties PropertyTypeDefault Encrypted [a] Required [b] targetDirectory File null Directory into which to write classes. warningLevel int 1 Warning Level of the compiler scriptExtensions String[] ['groovy'] Gets the extensions used to find groovy files scriptBaseClass String null Base class name for scripts (must derive from Script) scriptRoots String[] null The root folder to load the scripts from. If the value is null or empty the classpath value is used. tolerance int 10 The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. disabledGlobalASTTransformations String[] null Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. sourceEncoding String UTF-8 Encoding for source files recompileGroovySource boolean false If set to true recompilation is enabled minimumRecompilationInterval int 100 Sets the minimum of time after a script can be recompiled. debug boolean false If true, debugging code should be activated classpath String[] [] Classpath for use during compilation. verbose boolean false If true, the compiler should produce action information [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. #### 8.3.1.3. Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] password String null The connection password to be passed to our JDBC driver to establish a connection. Note that method DataSource.getConnection(username,password) by default will not use credentials passed into the method, but will use the ones configured here. See alternateUsernameAllowed property for more details. customSensitiveConfiguration GuardedString null Custom Sensitive Configuration script for Groovy ConfigSlurper customConfiguration String null Custom Configuration script for Groovy ConfigSlurper connectionProperties String null The connection properties that will be sent to our JDBC driver when establishing new connections. Format of the string must be [propertyName=property;]* NOTE - The "user" and "password" properties will be passed explicitly, so they do not need to be included here. The default value is null. propagateInterruptState boolean false Set this to true to propagate the interrupt state for a thread that has been interrupted (not clearing the interrupt state). Default value is false for backwards compatibility. useDisposableConnectionFacade boolean true Set this to true if you wish to put a facade on your connection so that it cannot be reused after it has been closed. This prevents a thread holding on to a reference of a connection it has already called closed on, to execute queries on it. defaultCatalog String null The default catalog of connections created by this pool. validationInterval long 3000 avoid excess validation, only run validation at most at this frequency - time in milliseconds. If a connection is due for validation, but has been validated previously within this interval, it will not be validated again. The default value is 30000 (30 seconds). ignoreExceptionOnPreLoad boolean false Flag whether ignore error of connection creation while initializing the pool. Set to true if you want to ignore error of connection creation while initializing the pool. Set to false if you want to fail the initialization of the pool by throwing exception. jmxEnabled boolean true Register the pool with JMX or not. The default value is true. commitOnReturn boolean false If autoCommit==false then the pool can complete the transaction by calling commit on the connection as it is returned to the pool If rollbackOnReturn==true then this attribute is ignored. Default value is false. logAbandoned boolean false Flag to log stack traces for application code which abandoned a Connection. Logging of abandoned Connections adds overhead for every Connection borrow because a stack trace has to be generated. The default value is false. maxIdle int 100 The maximum number of connections that should be kept in the pool at all times. Default value is maxActive:100 Idle connections are checked periodically (if enabled) and connections that been idle for longer than minEvictableIdleTimeMillis will be released. (also see testWhileIdle) testWhileIdle boolean false The indication of whether objects will be validated by the idle object evictor (if any). If an object fails to validate, it will be dropped from the pool. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. The default value is false and this property has to be set in order for the pool cleaner/test thread is to run (also see timeBetweenEvictionRunsMillis) removeAbandoned boolean false Flag to remove abandoned connections if they exceed the removeAbandonedTimeout. If set to true a connection is considered abandoned and eligible for removal if it has been in use longer than the removeAbandonedTimeout Setting this to true can recover db connections from applications that fail to close a connection. See also logAbandoned The default value is false. abandonWhenPercentageFull int 0 Connections that have been abandoned (timed out) wont get closed and reported up unless the number of connections in use are above the percentage defined by abandonWhenPercentageFull. The value should be between 0-100. The default value is 0, which implies that connections are eligible for closure as soon as removeAbandonedTimeout has been reached. minIdle int 10 The minimum number of established connections that should be kept in the pool at all times. The connection pool can shrink below this number if validation queries fail. Default value is derived from initialSize:10 (also see testWhileIdle) defaultReadOnly Boolean null The default read-only state of connections created by this pool. If not set then the setReadOnly method will not be called. (Some drivers dont support read only mode, ex: Informix) maxWait int 30000 The maximum number of milliseconds that the pool will wait (when there are no available connections) for a connection to be returned before throwing an exception. Default value is 30000 (30 seconds) logValidationErrors boolean false Set this to true to log errors during the validation phase to the log file. If set to true, errors will be logged as SEVERE. Default value is false for backwards compatibility. driverClassName String null The fully qualified Java class name of the JDBC driver to be used. The driver has to be accessible from the same classloader as tomcat-jdbc.jar name String Tomcat Connection Pool[1-340884009] Returns the name of the connection pool. By default a JVM unique random name is assigned. useStatementFacade boolean true If a statement proxy is set, wrap statements so that equals() and hashCode() methods can be called on closed statements. initSQL String null A custom query to be run when a connection is first created. The default value is null. validationQueryTimeout int -1 The timeout in seconds before a connection validation queries fail. This works by calling java.test_sample.Statement.setQueryTimeout(seconds) on the statement that executes the validationQuery. The pool itself doesnt timeout the query, it is still up to the JDBC driver to enforce query timeouts. A value less than or equal to zero will disable this feature. The default value is -1. validationQuery String null The SQL query that will be used to validate connections from this pool before returning them to the caller. If specified, this query does not have to return any data, it just cant throw a SQLException. The default value is null. Example values are SELECT 1(mysql), select 1 from dual(oracle), SELECT 1(MS Sql Server) rollbackOnReturn boolean false If autoCommit==false then the pool can terminate the transaction by calling rollback on the connection as it is returned to the pool Default value is false. alternateUsernameAllowed boolean false By default, the jdbc-pool will ignore the DataSource.getConnection(username,password) call, and simply return a previously pooled connection under the globally configured properties username and password, for performance reasons. The pool can however be configured to allow use of different credentials each time a connection is requested. To enable the functionality described in the DataSource.getConnection(username,password) call, simply set the property alternateUsernameAllowed to true. Should you request a connection with the credentials user1/password1 and the connection was previously connected using different user2/password2, the connection will be closed, and reopened with the requested credentials. This way, the pool size is still managed on a global level, and not on a per schema level. dataSourceJNDI String null The JNDI name for a data source to be looked up in JNDI and then used to establish connections to the database. See the dataSource attribute. Default value is null validatorClassName String null The name of a class which implements the org.apache.tomcat.jdbc.pool.Validator interface and provides a no-arg constructor (may be implicit). If specified, the class will be used to create a Validator instance which is then used instead of any validation query to validate connections. The default value is null. An example value is com.mycompany.project.SimpleValidator. suspectTimeout int 0 Timeout value in seconds. Similar to to the removeAbandonedTimeout value but instead of treating the connection as abandoned, and potentially closing the connection, this simply logs the warning if logAbandoned is set to true. If this value is equal or less than 0, no suspect checking will be performed. Suspect checking only takes place if the timeout value is larger than 0 and the connection was not abandoned or if abandon check is disabled. If a connection is suspect a WARN message gets logged and a JMX notification gets sent once. useEquals boolean true Set to true if you wish the ProxyConnection class to use String.equals and set to false when you wish to use == when comparing method names. This property does not apply to added interceptors as those are configured individually. The default value is true. removeAbandonedTimeout int 60 Timeout in seconds before an abandoned(in use) connection can be removed. The default value is 60 (60 seconds). The value should be set to the longest running query your applications might have. defaultAutoCommit Boolean null The default auto-commit state of connections created by this pool. If not set, default is JDBC driver default (If not set then the setAutoCommit method will not be called.) testOnConnect boolean false Validate the connection when connecting to the database for the first time. False by default. Set to true if you want to use the validationQuery as an init query. jdbcInterceptors String null A semicolon separated list of classnames extending org.apache.tomcat.jdbc.pool.JdbcInterceptor class. See Configuring JDBC interceptors below for more detailed description of syntaz and examples. These interceptors will be inserted as an interceptor into the chain of operations on a java.test_sample.Connection object. The default value is null. initialSize int 10 The initial number of connections that are created when the pool is started. Default value is 10 defaultTransactionIsolation int -1 The default TransactionIsolation state of connections created by this pool. One of the following: NONE, READ_COMMITTED, READ_UNCOMMITTED, REPEATABLE_READ, SERIALIZABLE If not set, the method will not be called and it defaults to the JDBC driver. numTestsPerEvictionRun int 0 Property not used in tomcat-jdbc-pool. url String null The URL used to connect to the database. testOnBorrow boolean false The indication of whether objects will be validated before being borrowed from the pool. If the object fails to validate, it will be dropped from the pool, and we will attempt to borrow another. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. In order to have a more efficient validation, see validationInterval. Default value is false fairQueue boolean true Set to true if you wish that calls to getConnection should be treated fairly in a true FIFO fashion. This uses the org.apache.tomcat.jdbc.pool.FairBlockingQueue implementation for the list of the idle connections. The default value is true. This flag is required when you want to use asynchronous connection retrieval. Setting this flag ensures that threads receive connections in the order they arrive. During performance tests, there is a very large difference in how locks and lock waiting is implemented. When fairQueue=true there is a decision making process based on what operating system the system is running. If the system is running on Linux (property os.name=Linux. To disable this Linux specific behavior and still use the fair queue, simply add the property org.apache.tomcat.jdbc.pool.FairBlockingQueue.ignoreOS=true to your system properties before the connection pool classes are loaded. accessToUnderlyingConnectionAllowed boolean true Property not used. Access can be achieved by calling unwrap on the pooled connection. see javax.test_sample.DataSource interface, or call getConnection through reflection or cast the object as javax.test_sample.PooledConnection maxAge long 0 Time in milliseconds to keep this connection. When a connection is returned to the pool, the pool will check to see if the now - time-when-connected > maxAge has been reached, and if so, it closes the connection rather than returning it to the pool. The default value is 0, which implies that connections will be left open and no age check will be done upon returning the connection to the pool. minEvictableIdleTimeMillis int 60000 The minimum amount of time an object may sit idle in the pool before it is eligible for eviction. The default value is 60000 (60 seconds). timeBetweenEvictionRunsMillis int 5000 The number of milliseconds to sleep between runs of the idle connection validation/cleaner thread. This value should not be set under 1 second. It dictates how often we check for idle, abandoned connections, and how often we validate idle connections. The default value is 5000 (5 seconds). testOnReturn boolean false The indication of whether objects will be validated before being returned to the pool. NOTE - for a true value to have any effect, the validationQuery parameter must be set to a non-null string. The default value is false. useLock boolean false Use a lock when performing operations on the connection object. False by default. Set to true if you will use a separate background thread for idle and abandon checking (e.g. JMX clients). If the pool sweeper is enabled, a lock is used, regardless of this setting. maxActive int 100 The maximum number of active connections that can be allocated from this pool at the same time. The default value is 100 username String null The connection username to be passed to our JDBC driver to establish a connection. Note that method DataSource.getConnection(username,password) by default will not use credentials passed into the method, but will use the ones configured here. See alternateUsernameAllowed property for more details. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. # Chapter 9. SAP Connector The SAP connector is an implementation of the Scripted Groovy Connector Toolkit that connects to any SAP system using the SAP JCo Java libraries. This chapter describes how to install and configure the scripted SAP connector, and how to test the sample scripts that are bundled with the connector. The sample scripts illustrate the following scenarios: • Synchronization of users between an SAP HR module and IDM • Synchronization of users between IDM and an SAP (R/3) system ## 9.1. Before You Start 1. Download the SAP connector from the ForgeRock BackStage download site. 2. Copy the SAP connector JAR file (sap-connector-1.5.1.0.jar) to the openidm/connectors directory: $ cp ~/Downloads/sap-connector-1.5.1.0.jar /path/to/openidm/connectors
3. The SAP connector requires the SAP Java Connector (JCo) libraries, version 3.0.12 or later. ForgeRock distributes the SAP connector without these JCo libraries. Before you can use the SAP connector, you must obtain the JCo libraries that correspond to your architecture.

Copy the required SAP JCo libraries to the /path/to/openidm/lib directory. For example:

$cp sapjco3.jar /path/to/openidm/lib$ cp libsapjco3.so /path/to/openidm/lib
4. Change your IDM logging configuration to log messages from the SAP connector.

By default, IDM logs nothing for the SAP connector. To troubleshoot any issues with the connector, set the following properties in your project's conf/logging.properties file:

# SAP Connector Logging
org.forgerock.openicf.connectors.sap.level=FINER
scripts.sap.r3.level=FINER
scripts.sap.hr.level=FINER
scripts.sap.level=FINER

## 9.2. Using the SAP Connector With an SAP HR System

The SAP HR sample scripts enable you to manage the email address and global employee UID of records in an SAP HR system.

The following sections explain how to configure IDM to use these sample scripts, how to test the connection to the SAP HR system, and how to update user records.

### 9.2.1. Setting up IDM for the SAP HR Samples

1. Create a connector configuration file for the SAP connector and place it in your project's conf/ directory.

You can use this sample provisioner.openicf-saphr.json as a guide.

Edit that file with the connection details for your SAP HR system. Specifically, set at least the following properties:

destination

An alias to the SAP system to which you are connecting, for example, SAP1. If you are connecting to more than one SAP system, the destination property for each system must be unique.

The sample connector configuration assumes a connection to a single SAP system, so the value for this property in the sample configuration is OPENIDM.

asHost

The FQDN of your SAP Application Server, for example sap.example.com.

user

password

The password of this SAP user account.

client

The SAP Client number that will be used to connect to the SAP system.

systemNumber

The SAP system number.

directConnection

A boolean (true/false). If true, the connection goes directly to an SAP ABAP Application server or SAP router. If false, the connection goes to a group of SAP instances, through an SAP message server.

sapRouter

The IP address and port of the SAP router, if applicable. The syntax is /H/host[/S/port], for example /H/203.0.113.0/S/3299.

poolCapacity

The maximum number of idle connections kept open by the destination. If there is no connection pooling, set this to 0. The default value is 1.

For optimum performance, set this value to an integer between 5 and 10.

2. The connector bundles a number of SAP-certified sample Groovy scripts:

 TestSAP.groovy SearchSAPHR.groovy UpdateSAPHR.groovy SchemaSAPHR.groovy EmplComm.groovy

If necessary, you can customize these scripts to suit your deployment by extracting them from the connector JAR and updating the connector configuration to point to the new file path.

The sample connector configuration assumes the following locations for the scripts (relative to the value of the scriptRoots property):

"testScriptFileName" : "scripts/sap/TestSAP.groovy",
"searchScriptFileName" : "scripts/sap/hr/SearchSAPHR.groovy",
"schemaScriptFileName" : "scripts/sap/hr/SchemaSAPHR.groovy",

The EmplComm.groovy must be placed in the same location as the Search, Update, and Schema scripts.

### Important

The Groovy scripts belong to a specific package. The parent directory where the scripts are located must be the same as the package name. So the TestSAP.groovy script must be under a scripts/sap directory (because it belongs to the scripts/sap package) and the remaining HR scripts must be under a scripts/sap/hr directory (because they belong to the hr package).

### 9.2.2. Testing the Connection to the SAP HR System

1. Start IDM with the configuration for your SAP connector project.

This procedure assumes that the configuration is in the default path/to/openidm directory. If your SAP project is in a different directory, use the -p option with the startup command to point to that directory.

$cd path/to/openidm$ ./startup.sh
2. Test that the connector has been configured correctly and that the SAP HR system can be reached:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ "http://localhost:8080/openidm/system/saphr/?_action=test" { "name" : "saphr", "enabled" : true, "config" : "config/provisioner.openicf/saphr2", "objectTypes" : [ "__ALL__", "employee" ], "connectorRef" : { "connectorName" : "org.forgerock.openicf.connectors.sap.SapConnector", "bundleName" : "org.forgerock.openicf.connectors.sap-connector", "bundleVersion" : "1.5.1.0" }, "displayName" : "Sap Connector", "ok" : true } 3. Retrieve a list of the existing users (with their employee number) in the SAP HR system: $ curl \
--request GET \
"http://localhost:8080/openidm/system/saphr/employee?_queryId=query-all-ids"
{
"result" : [ {
"_id" : "00000010",
"__NAME__" : "00000010"
}, {
"_id" : "00000069",
"__NAME__" : "00000069"
}, {
"_id" : "00000070",
"__NAME__" : "00000070"
},
...
4. Retrieve the complete record of an employee in the SAP HR system by including the employee's ID in the URL.

The following command retrieves the record for employee Maria Gonzales:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request GET \ "http://localhost:8080/openidm/system/saphr/employee/55099307" { "_id" : "55099307", "PERSONAL_DATA" : { "PERNO" : "55099307", "INFOTYPE" : "0002", "TO_DATE" : "Fri Dec 31 00:00:00 CET 9999", "FROM_DATE" : "Tue Mar 30 00:00:00 CET 1954", "SEQNO" : "000", "CH_ON" : "Thu Mar 27 00:00:00 CET 2003", "CHANGED_BY" : "MAYROCK", "LAST_NAME" : "Gonzales", "FIRSTNAME" : "Maria", "NAME_FORM" : "00", "FORMOFADR" : "2", "GENDER" : "2", "BIRTHDATE" : "Tue Mar 30 00:00:00 CET 1954", "LANGU" : "D", "NO_O_CHLDR" : "0", "BIRTHYEAR" : "1954", "BIRTHMONTH" : "03", "BIRTHDAY" : "30", "LASTNAME_M" : "GONZALES", "FSTNAME_M" : "MARIA" }, ... } ### 9.2.3. Using the SAP Connector to Manage Employee Information (SAP HR) The following sample commands show how the SAP connector is used to manage the email account of user Maria Gonzales, retrieved in the previous step. Management of the global UID (SYS-UNAME) works in the same way. 1. Check if Maria Gonzales already has an email account on the SAP HR system by filtering a query on her user account for the EMAIL field: $ curl \
--request GET \
"http://localhost:8080/openidm/system/saphr/employee/55099307?_fields=EMAIL"
{
"_id" : "55099307",
}

No email account is found for Maria Gonzales.

2. Add an email account by sending a PUT request. The JSON payload should include the email address as the value of the ID property:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request PUT \ --data '{ "EMAIL": { "ID": "maria.gonzales@example.com" } }' \ "http://localhost:8080/openidm/system/saphr/employee/55099307" { "_id" : "55099307", "EMAIL" : [ { "EMPLOYEENO" : "55099307", "SUBTYPE" : "0010", "VALIDEND" : "Fri Dec 31 00:00:00 CET 9999", "VALIDBEGIN" : "Fri March 18 00:00:00 CET 2016", "RECORDNR" : "000", "COMMTYPE" : "0010", "NAMEOFCOMMTYPE" : "E-mail", "ID" : "Maria.Gonzales@example.com" } ], ... By default, the connector sets the VALIDBEGIN date to the current date, and the VALIDEND date to the SAP "END" date (12/31/9999). You can specify different temporal constraints by including these properties in the JSON payload, with the format YYYYMMDD. For example: { "EMAIL": { "ID": "maria.gonzales@example.com" "VALIDBEGIN": "20160401", "VALIDEND": "20161231" } } 3. To change the value of an existing email account, provide a new value for the ID. The JSON payload of the change request must also include the RECORDNR attribute, as well as the VALIDBEGIN and VALIDEND dates, in SAP format (YYYYMMDD). The following example changes Maria Gonzales' email address to maria.gonzales-admin@example.com: $ curl \
--request PUT \
--data '{
"EMAIL": {
"RECORDNR" : "000",
"VALIDEND" : "99991231",
"VALIDBEGIN" : "20000101"
}
}' \
"http://localhost:8080/openidm/system/saphr/employee/55099307"
4. To change the temporal constraint (VALIDEND date) of the record, include the existing VALIDEND data in the JSON payload, and specify the new end date as a value of the DELIMIT_DATE attribute.

The following example changes the end date of Maria Gonzale's new mail address to December 31st, 2016:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request PUT \ --data '{ "EMAIL": { "ID": "maria.gonzales-admin@example.com", "RECORDNR" : "000", "VALIDEND" : "99991231", "VALIDBEGIN" : "20000101", "DELIMIT_DATE": "20161231" } }' \ "http://localhost:8080/openidm/system/saphr/employee/55099307" 5. To delete the email address of the record, send a PUT request with the current RECORDNR, VALIDBEGIN, and VALIDEND attributes, but without the ID. The following request removes the email address from Maria Gonzales' record: $ curl \
--request PUT \
--data '{
"EMAIL": {
"RECORDNR" : "000",
"VALIDEND" : "99991231",
"VALIDBEGIN" : "20000101"
}
}' \
"http://localhost:8080/openidm/system/saphr/employee/55099307"

## 9.3. Using the SAP Connector to Manage SAP Basis System (R/3) Users

The SAP Connector lets you perform the following operations on SAP system user accounts:

• List all users

• List all activity groups (roles)

• Manage user profiles

• List all user companies

• Obtain a user's details

• Create a user

• Update a user

• Assign roles to a user

• Lock a user account

• Unlock a user account

• Delete a user account

Currently, the SAP connector cannot detect changes on the SAP system in real time. You must run a reconciliation operation to detect changes on the SAP system.

### 9.3.1. Setting up IDM for the SAP R/3 Samples

1. Create a connector configuration file for the SAP connector and place it in your project's conf/ directory.

You can use this sample provisioner.openicf-sapr3.json as a guide.

Edit that file with the connection details for your SAP R/3 system. Specifically, set at least the following properties:

destination

An alias to the SAP system to which you are connecting, for example, SAP1. If you are connecting to more than one SAP system, the destination property for each system must be unique.

The sample connector configuration assumes a connection to a single SAP system, MYSAP.

asHost

The FQDN of your SAP Application Server, for example sap.example.com.

user

password

The password of this SAP user account.

client

The SAP Client number that will be used to connect to the SAP system.

systemNumber

The SAP system number.

directConnection

A boolean (true/false). If true, the connection goes directly to an SAP ABAP Application server or SAP router. If false, the connection goes to a group of SAP instances, through an SAP message server.

sapRouter

The IP address and port of the SAP router, if applicable. The syntax is /H/host[/S/port], for example /H/203.0.113.0/S/3299.

poolCapacity

The maximum number of idle connections kept open by the destination. If there is no connection pooling, set this to 0. The default value is 1.

For optimum performance, set this value to an integer between 5 and 10.

2. The connector bundles a number of SAP-certified sample Groovy scripts:

 TestSAP.groovy SearchSAPR3.groovy CreateSAPR3.groovy UpdateSAPR3.groovy DeleteSAPR3.groovy SchemaSAPR3.groovy

If necessary, you can customize these scripts to suit your deployment by extracting them from the connector JAR and updating the connector configuration to point to the new file path.

The sample connector configuration assumes the following locations for the scripts (relative to the value of the scriptRoots property):

"testScriptFileName" : "scripts/sap/TestSAP.groovy",
"searchScriptFileName" : "scripts/sap/r3/SearchSAPR3.groovy",
"createScriptFileName" : "scripts/sap/r3/CreateSAPR3.groovy",
"deleteScriptFileName" : "scripts/sap/r3/DeleteSAPR3.groovy",
"schemaScriptFileName" : "scripts/sap/r3/SchemaSAPR3.groovy",

### Important

The Groovy scripts belong to a specific package. The parent directory where the scripts are located must be the same as the package name. So the TestSAP.groovy script must be under a scripts/sap directory (because it belongs to the scripts/sap package) and the R/3 scripts must be under a scripts/sap/r3 directory (because they belong to the r3 package).

### 9.3.2. Testing the Connection to the SAP R/3 System

1. Start IDM with the configuration for your SAP R/3 project.

This procedure assumes that the configuration is in the default path/to/openidm directory. If your SAP project is in a different directory, use the -p option with the startup command to point to that directory.

$cd path/to/openidm$ ./startup.sh
2. Test that the connector has been configured correctly and that the SAP R/3 system can be reached:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ "http://localhost:8080/openidm/system/mysap/?_action=test" { "name": "mysap", "enabled": true, "config": "config/provisioner.openicf/mysap", "objectTypes": [ "__ALL__", "user", "activity_group", "company", "profile" ], "connectorRef": { "connectorName": "org.forgerock.openicf.connectors.sap.SapConnector", "bundleName": "org.forgerock.openicf.connectors.sap-connector", "bundleVersion": "1.5.1.0" }, "displayName": "Sap Connector", "ok": true } ### 9.3.3. Using the SAP Connector to Manage SAP R/3 Users This section provides sample commands for managing users in an SAP system. #### 9.3.3.1. Listing the Users in the SAP System The following command returns a list of the existing users in the SAP system, with their IDs: $ curl \
--request GET \
"http://localhost:8080/openidm/system/mysap/user?_queryId=query-all-ids"
{
"result": [
{
"_id": "BJENSEN",
"__NAME__": "BJENSEN"
},
{
"_id": "DDIC",
"__NAME__": "DDIC"
},
...
{
"_id": "USER4",
"__NAME__": "USER4"
},
{
"_id": "USER6",
"__NAME__": "USER6"
},
{
"_id": "USER7",
"__NAME__": "USER7"
}
],
"resultCount": 9,
"totalPagedResultsPolicy": "NONE",
"totalPagedResults": -1,
"remainingPagedResults": -1
}

#### 9.3.3.2. Obtaining the Details of an SAP User

The following command uses the SAP connector to obtain a user's details from a target SAP system:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request GET \ "http://localhost:8080/openidm/system/mysap/user/BJENSEN" { "__NAME__": "BJENSEN", "__ENABLE__": true, "__ENABLE_DATE__": "2015-09-01", "__DISABLE_DATE__": "2016-09-01", "__LOCK_OUT__": false, "ADDTEL": [ { "COUNTRY": "DE", "TELEPHONE": "19851444", ... }, ... ], "PROFILES": [ { "BAPIPROF": "T_ALM_CONF", ... } ], "ISLOCKED": { "WRNG_LOGON": "U", ... }, "ACTIVITYGROUPS": [ { "AGR_NAME": "MW_ADMIN", "FROM_DAT": "2015-07-15", "TO_DAT": "9999-12-31", "AGR_TEXT": "Middleware Administrator" }, ... ], "DEFAULTS": { ... }, "COMPANY": { "COMPANY": "SAP AG" }, "ADDRESS": { ... }, "UCLASS": { ... }, "LASTMODIFIED": { "MODDATE": "2015-07-15", "MODTIME": "14:22:57" }, "LOGONDATA": { "GLTGV": "2015-09-01", "GLTGB": "2016-09-01", ... }, "_id": "BJENSEN" } In addition to the standard user attributes, the GET request returns the following ICF operational attributes: • __ENABLE__ - indicates whether the account is enabled, based on the value of the LOGONDATA attribute • __ENABLE_DATE__ - set to the value of LOGONDATA/GLTGV (date from which the user account is valid) • __DISABLE_DATE__ - set to the value of LOGONDATA/GLTGB (date to which the user account is valid) • __LOCK_OUT__ - indicates whether the account is locked #### 9.3.3.3. Creating SAP User Accounts To create a user, you must supply at least a username and password. If you do not provide a lastname, the connector uses the value of the username. The following command creates a new SAP user, SCARTER: $ curl \
--request POST \
--data '{
"__NAME__" : "SCARTER",
}' \
"http://localhost:8080/openidm/system/mysap/user/?_action=create"
{
"_id": "SCARTER",
"COMPANY": {
"COMPANY": "SAP AG"
},
"__LOCK_OUT__": false,
...
},
"__NAME__": "SCARTER",
"LASTMODIFIED": {
"MODDATE": "2016-04-20",
"MODTIME": "04:14:29"
},
"UCLASS": {
"COUNTRY_SURCHARGE": "0",
"SUBSTITUTE_FROM": "0000-00-00",
"SUBSTITUTE_UNTIL": "0000-00-00"
},
"__ENABLE__": true,
"DEFAULTS": {
"SPDB": "H",
"SPDA": "K",
"DATFM": "1",
"TIMEFM": "0"
},
"LOGONDATA": {
...
},
"ISLOCKED": {
"WRNG_LOGON": "U",
"LOCAL_LOCK": "U",
"GLOB_LOCK": "U",
"NO_USER_PW": "U"
}
}

The SAP account that is created is valid and enabled, but the password is expired by default. To log into the SAP system, the newly created user must first provide a new password.

To create a user with a valid (non-expired) password, include the __PASSWORD_EXPIRED__ attribute in the JSON payload, with a value of false. For example:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request POST \ --data '{ "__NAME__" : "SCARTER", "__PASSWORD__": "Passw0rd", "__PASSWORD_EXPIRED__": false }' \ "http://localhost:8080/openidm/system/mysap/user/?_action=create" To create an account that is locked by default, include the __LOCK_OUT__ attribute in the JSON payload, with a value of true. For example: $ curl \
--request POST \
--data '{
"__NAME__" : "SCARTER",
"__LOCK_OUT__": true
}' \
"http://localhost:8080/openidm/system/mysap/user/?_action=create"
{
"__NAME__": "SCARTER",
"__ENABLE__": false,
"__LOCK_OUT__": true,
"LOGONDATA": {
"GLTGV": "0000-00-00",
"GLTGB": "0000-00-00",
"USTYP": "A",
"LTIME": "00:00:00",
"BCODE": "2FC0D86C99AA5862",
"CODVN": "B",
"PASSCODE": "1DBBD983287D7CB4D8177B4333F439F808A395FA",
"CODVC": "F",
"PWDSALTEDHASH": "{x-issha, 1024}zrs3Zm/fX/l/KFGATp3kvOGlis3zLLiPmPVCDpJ9XF0=",
"CODVS": "I"
},
"LASTMODIFIED": {
"MODDATE": "2015-10-01",
"MODTIME": "15:25:18"
},
"ISLOCKED": {
"WRNG_LOGON": "U",
"LOCAL_LOCK": "L",     // "L" indicates that the user is locked on the local system
"GLOB_LOCK": "U",
"NO_USER_PW": "U"
},
...
##### 9.3.3.3.1. Schema Used by the SAP Connector For User Accounts

For the most part, the SAP connector uses the standard SAP schema to create a user account. The most common attributes in an SAP user account are as follows:

• ADDRESS - user address data

• LOGONDATA - user logon data

• DEFAULTS - user account defaults

• COMPANY - the company to which the user is assigned

• REF_USER - the usernames of the Reference User

• ALIAS - an alias for the username

• UCLASS - license-related user classification

• LASTMODIFIED - read-only attribute that indicates the date and time that the account was last changed

• ISLOCKED - read-only attribute that indicates the lockout status of the account

• IDENTITY - assignment of a personal identity to the user account

• PROFILES - any profiles assigned to the user account (see "Managing User Profiles").

• ACTIVITYGROUPS - activity groups assigned to the user

• ADDTEL - telephone numbers assigned to the user

In addition, the SAP connector supports the following ICF operational attributes for CREATE requests:

• LOCK_OUT

• PASSWORD

• PASSWORD_EXPIRED

The following example creates a user, KVAUGHAN, with all of the standard attributes:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request POST \ --data '{ "__NAME__" : "KVAUGHAN", "__PASSWORD__": "Passw0rd", "__PASSWORD_EXPIRED__": false, "LOGONDATA": { "GLTGV": "2016-04-01", "GLTGB": "2016-12-01", "USTYP": "A" }, "ADDRESS": { "FIRSTNAME": "Katie", "LASTNAME": "Vaughan", "TEL1_NUMBR": "33297603177", "E_MAIL": "katie.vaughan@example.com", "FUNCTION": "Test User" }, "COMPANY": { "COMPANY": "EXAMPLE.COM" }, "ALIAS": { "USERALIAS": "KVAUGHAN" } }' \ "http://localhost:8080/openidm/system/mysap/user/?_action=create" { "_id": "KVAUGHAN", "ADDRESS": { "PERS_NO": "0000010923", "ADDR_NO": "0000010765", "FIRSTNAME": "Katie", "LASTNAME": "Vaughan", "FULLNAME": "Katie Vaughan", ... "E_MAIL": "katie.vaughan@example.com", "LANGU_CR_P": "E", "LANGUCPISO": "EN" }, "LOGONDATA": { "GLTGV": "2016-04-01", "GLTGB": "2016-12-01", ... }, "COMPANY": { "COMPANY": "SAP AG" }, "__ENABLE__": true, "ADDTEL": [ { ... } ], "ISLOCKED": { "WRNG_LOGON": "U", "LOCAL_LOCK": "U", "GLOB_LOCK": "U", "NO_USER_PW": "U" }, "UCLASS": { "COUNTRY_SURCHARGE": "0", "SUBSTITUTE_FROM": "0000-00-00", "SUBSTITUTE_UNTIL": "0000-00-00" }, "ALIAS": { "USERALIAS": "KVAUGHAN" }, "__NAME__": "KVAUGHAN", "__LOCK_OUT__": false, "LASTMODIFIED": { "MODDATE": "2016-04-20", "MODTIME": "04:55:08" }, "__ENABLE_DATE__": "2016-04-01", // (Value of LOGONDATA/GLTGV) "DEFAULTS": { "SPDB": "H", "SPDA": "K", "DATFM": "1", "TIMEFM": "0" }, "__DISABLE_DATE__": "2016-12-01" // (Value of LOGONDATA/GLTGB) }  #### 9.3.3.4. Updating SAP User Accounts The following sections provide sample commands for updating an existing user account. ##### 9.3.3.4.1. Locking and Unlocking an Account To lock or unlock a user's account, send a PUT request, and set the value of the user's __LOCK_OUT__ attribute to true. The following example locks user KVAUGHAN's account: $ curl \
--request PUT \
--data '{
"__LOCK_OUT__": true
}' \
"http://localhost:8080/openidm/system/mysap/user/KVAUGHAN"

The following example unlocks KVAUGHAN's account:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match: *" \ --request PUT \ --data '{ "__LOCK_OUT__": false }' \ "http://localhost:8080/openidm/system/mysap/user/KVAUGHAN" ##### 9.3.3.4.2. Updating the Standard Attributes of a User's Account To update a user's standard attributes, send a PUT request to the user ID. The JSON payload must respect the structure for each attribute, as indicated in "Schema Used by the SAP Connector For User Accounts". The following command updates the ADDRESS attribute of user KVAUGHAN: $ curl \
--request PUT \
--data '{
"FIRSTNAME": "Katie",
"LASTNAME": "Vaughan",
"FULLNAME": "Katie Vaughan",
"TITLE": "Company",
"NAME": "EXAMPLE.COM",
"CITY": "San Francisco",
"POSTL_COD1": "94105",
"STREET": "Sacramento St",
"HOUSE_NO": "2912",
"COUNTRY": "US",
"COUNTRYISO": "US",
"LANGU": "E",
"LANGU_ISO": "EN",
"REGION": "CA",
"TIME_ZONE": "PST",
"TEL1_NUMBR": "33297603177",
"E_MAIL": "katie.vaughan@example.com",
"LANGU_CR_P": "E",
"LANGUCPISO": "EN"
}
}' \
"http://localhost:8080/openidm/system/mysap/user/KVAUGHAN"
##### 9.3.3.4.3. Resetting a User's Password

To reset the user's password, provide the new password as the value of the __PASSWORD__ attribute, in a PUT request. The following command resets KVAUGHAN's password to MyPassw0rd:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match: *" \ --request PUT \ --data '{ "__PASSWORD__": "MyPassw0rd" }' \ "http://localhost:8080/openidm/system/mysap/user/KVAUGHAN" Note that unless you set the __PASSWORD_EXPIRED__ attribute to false, the user will be required to reset her password the next time she logs into the SAP system. The following command resets KVAUGHAN's password to MyPassw0rd, and ensures that she does not have to reset her password the next time she logs in: $ curl \
--request PUT \
--data '{
}'
"http://localhost:8080/openidm/system/mysap/user/KVAUGHAN"

#### 9.3.3.5. Deleting User Accounts

To delete a user account, send a DELETE request to the user ID. The following example deletes KVAUGHAN:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request DELETE \ "http://localhost:8080/openidm/system/mysap/user/KVAUGHAN" The command returns the complete user object that was deleted. #### 9.3.3.6. Managing User Profiles An SAP system uses profiles to manage authorization. The following examples demonstrate how to add, change, and remove a user's profiles. ##### 9.3.3.6.1. Creating a User With One or More Profiles Profiles are added as an array of one or more objects. The following command creates a user BJENSEN, with the system administrator profile (S_A.SYSTEM): $ curl \
--request POST \
--data '{
"__NAME__" : "BJENSEN",
"PROFILES": [
{"BAPIPROF": "S_A.SYSTEM"}
]
}' \
"http://localhost:8080/openidm/system/mysap/user/?_action=create"
{
"_id": "BJENSEN",
"COMPANY": {
"COMPANY": "SAP AG"
},
"PROFILES": [
{
"BAPIPROF": "S_A.SYSTEM",
"BAPITYPE": "S",
"BAPIAKTPS": "A"
}
],
...
"__NAME__": "BJENSEN"
}

Note that the additional information regarding that profile is added to the user account automatically.

##### 9.3.3.6.2. Updating a User's Profiles

To update a user's profiles, send a PUT request to the user's ID, specifying the new profiles as an array of values for the PROFILES attribute. The values provided in the PUT request will replace the current profiles, so you must include the existing profiles in the request.

The following example adds the SAP_ALL profile to user BJENSEN's account:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match: *" \ --request PUT \ --data '{ "PROFILES": [ {"BAPIPROF": "S_A.SYSTEM"}, {"BAPIPROF": "SAP_ALL"} ] }' \ "http://localhost:8080/openidm/system/mysap/user/BJENSEN" { "_id": "BJENSEN", "COMPANY": { "COMPANY": "SAP AG" }, "PROFILES": [ { "BAPIPROF": "SAP_ALL", "BAPIPTEXT": "All SAP System authorizations", "BAPITYPE": "C", "BAPIAKTPS": "A" }, { "BAPIPROF": "S_A.SYSTEM", "BAPIPTEXT": "System administrator (Superuser)", "BAPITYPE": "S", "BAPIAKTPS": "A" } ], ... "__NAME__": "BJENSEN" } ##### 9.3.3.6.3. Removing All Profiles From a User Account To remove all profiles from a user's account, update the account with an empty array. The following example removes all profiles from BJENSEN's account: $ curl \
--request PUT \
--data '{
"PROFILES": []
}' \
"http://localhost:8080/openidm/system/mysap/user/BJENSEN"

"_id": "BJENSEN",
"COMPANY": {
"COMPANY": "SAP AG"
},
...
"__NAME__": "BJENSEN"
}

The output shows no PROFILES attribute, as this attribute is now empty for this user.

#### 9.3.3.7. Managing User Roles

SAP user roles (or activity groups) are an alternative mechanism to grant authorization to an SAP system. Essentially, a role encapsulates a set of one or more profiles.

Roles can be granted with temporal constraints, that is, a period during which the role is valid. If no temporal constraints are specified, the SAP connector sets the FROM date to the current date and the TO date to 9999-12-31.

##### 9.3.3.7.1. Creating a User With One or More Profiles

Roles are added as an array of one or more objects.

The following command creates a user SCARTER, with two roles: SAP_AUDITOR_SA_CCM_USR and SAP_ALM_ADMINISTRATOR. The auditor role has a temporal constraint, and is valid only from May 1st, 2016 to April 30th, 2017. The format of the temporal constraint is YYYY-mm-dd:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --request POST \ --data '{ "__NAME__" : "SCARTER", "__PASSWORD__": "Passw0rd", "__PASSWORD_EXPIRED__": false, "ACTIVITYGROUPS": [ { "AGR_NAME": "SAP_AUDITOR_SA_CCM_USR", "FROM_DAT": "2016-05-01", "TO_DAT": "2017-04-30" }, { "AGR_NAME": "SAP_ALM_ADMINISTRATOR" } ] }' \ "http://localhost:8080/openidm/system/mysap/user/?_action=create" { "_id": "SCARTER", "COMPANY": { "COMPANY": "SAP AG" }, "PROFILES": [ { "BAPIPROF": "T_ALM_CONF", "BAPIPTEXT": "Profile for the Role SAP_ALM_ADMINISTRATOR", "BAPITYPE": "G", "BAPIAKTPS": "A" } ], ... "ACTIVITYGROUPS": [ { "AGR_NAME": "SAP_ALM_ADMINISTRATOR", "FROM_DAT": "2016-04-20", "TO_DAT": "9999-12-31", "AGR_TEXT": "Alert Management Administrator" }, { "AGR_NAME": "SAP_AUDITOR_SA_CCM_USR", "FROM_DAT": "2016-05-01", "TO_DAT": "2017-04-30", "AGR_TEXT": "AIS - System Audit - Users and Authorizations" } ], "__NAME__": "SCARTER" } When a role is granted, the corresponding profiles are attached to the user account automatically. ##### 9.3.3.7.2. Updating a User's Roles To update a user's roles, send a PUT request to the user's ID, specifying the new roles as an array of values of the ACTIVITYGROUPS attribute. The values provided in the PUT request will replace the current ACTIVITYGROUPS. The following example removes the SAP_AUDITOR_SA_CCM_USR role and changes the temporal constraints on the SAP_ALM_ADMINISTRATOR role for SCARTER's account: $ curl \
--request PUT \
--data '{
"ACTIVITYGROUPS": [
{
"FROM_DAT": "2015-06-02",
"TO_DAT": "2016-06-02"
}
]
}' \
"http://localhost:8080/openidm/system/mysap/user/SCARTER"
{
"_id": "SCARTER",
"COMPANY": {
"COMPANY": "SAP AG"
},
"PROFILES": [
{
"BAPIPROF": "T_ALM_CONF",
"BAPIPTEXT": "Profile for the Role SAP_ALM_ADMINISTRATOR",
"BAPITYPE": "G",
"BAPIAKTPS": "A"
}
],
...
"ACTIVITYGROUPS": [
{
"FROM_DAT": "2015-06-02",
"TO_DAT": "2016-06-02",
}
],
"__NAME__": "SCARTER"
}

##### 9.3.3.7.3. Removing All Roles From a User Account

To remove all roles from a user's account, update the value of the ACTIVITYGROUPS attribute with an empty array. The following example removes all roles from SCARTER's account:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --header "Content-Type: application/json" \ --header "If-Match: *" \ --request PUT \ --data '{ "ACTIVITYGROUPS": [] }' \ "http://localhost:8080/openidm/system/mysap/user/SCARTER" { "_id": "SCARTER", "COMPANY": { "COMPANY": "SAP AG" }, ... "LASTMODIFIED": { "MODDATE": "2016-04-21", "MODTIME": "04:27:00" }, "__NAME__": "SCARTER" } The output shows no ACTIVITYGROUPS attribute, as this attribute is now empty. ## 9.4. Configuring the SAP Connector For SNC The SAP connector supports an SNC (Secure Network Connection) configuration. SNC is a software layer in the SAP System architecture that provides an interface to an external security product. For a list of the configuration properties specific to SNC, see "SAP Secure Network Connection Configuration Properties". ## 9.5. Implementation Specifics For PATCH requests, a connector can potentially add, remove, or replace an attribute value. The SAP connector implements the add, remove, and replace operations but the sample scripts provided with the connector implement only the replace operation. If you use these sample scripts, a PATCH request will therefore always replace the entire attribute value with the new value. ### 9.5.1. Setting Productive Passwords on the SAP System Synchronization of passwords to the SAP system requires that you configure SNC and SSO. If you do not configure these two elements correctly, passwords that are updated by IDM are set as initial passwords rather than productive passwords, and users are forced to change their passwords on login. 1. To configure the SAP connector to use SNC, set the sncMode property to "1". To configure the connector to use SSO with SNC, set the sncSSO property to "1". 2. The logon session during which a productive password is set must be secured using the authentication method Single Sign-On (SSO) using Secure Network Communications (SNC). IDM must request and receive an SSO logon ticket from the SAP system to allow the BAPI_USER_CHANGE process to set a productive password. For more information, see the corresponding SAP Note 1287410 at https://service.sap.com/sap/support/notes/1287410. To configure the connector to request this logon ticket, set the value of the x509Cert property as follows: • If you are using an X509 certificate to negotiate with the SAP server, set the x509Cert property to the base 64-encoded certificate. Note that the certificate must be a valid, CA-signed certificate. You cannot use a self-signed certificate here. • If you are not using an X509 certificate to negotiate with the SAP server, set the x509Cert property to null. In this case, the connector will use the user and password specified in the connector configuration to request the SSO logon ticket. ## 9.6. OpenICF Interfaces Implemented by the SAP Connector The SAP Connector implements the following OpenICF interfaces. Provides simple authentication with two parameters, presumed to be a user name and password. Creates an object and its uid. Deletes an object, referenced by its uid. Resolves an object by its username and returns the uid of the object. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Runs a script on the target resource that is managed by this connector. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 9.7. SAP Connector Configuration The SAP Connector has the following configurable properties. ### 9.7.1. Operation Script Files Properties PropertyTypeDefault Encrypted [a] Required [b] createScriptFileName String null  Create The name of the file used to perform the CREATE operation. customizerScriptFileName String null The script used to customize some function of the connector. Read the documentation for more details. resolveUsernameScriptFileName String null  Resolve Username The name of the file used to perform the RESOLVE_USERNAME operation. updateScriptFileName String null  Update The name of the file used to perform the UPDATE operation. schemaScriptFileName String null  Schema The name of the file used to perform the SCHEMA operation. authenticateScriptFileName String null  Authenticate The name of the file used to perform the AUTHENTICATE operation. scriptOnResourceScriptFileName String null  Script On Resource The name of the file used to perform the RUNSCRIPTONRESOURCE operation. deleteScriptFileName String null  Delete The name of the file used to perform the DELETE operation. searchScriptFileName String null  Get Search The name of the file used to perform the SEARCH operation. testScriptFileName String null  Test The name of the file used to perform the TEST operation. syncScriptFileName String null  Sync The name of the file used to perform the SYNC operation. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.2. Groovy Engine configuration Properties PropertyTypeDefault Encrypted [a] Required [b] targetDirectory File null Directory into which to write classes. warningLevel int 1 Warning Level of the compiler scriptExtensions String[] ['groovy'] Gets the extensions used to find groovy files scriptBaseClass String null Base class name for scripts (must derive from Script) scriptRoots String[] null The root folder to load the scripts from. If the value is null or empty the classpath value is used. tolerance int 10 The error tolerance, which is the number of non-fatal errors (per unit) that should be tolerated before compilation is aborted. disabledGlobalASTTransformations String[] null Sets a list of global AST transformations which should not be loaded even if they are defined in META-INF/org.codehaus.groovy.transform.ASTTransformation files. By default, none is disabled. sourceEncoding String UTF-8 Encoding for source files recompileGroovySource boolean false If set to true recompilation is enabled minimumRecompilationInterval int 100 Sets the minimum of time after a script can be recompiled. debug boolean false If true, debugging code should be activated classpath String[] [] Classpath for use during compilation. verbose boolean false If true, the compiler should produce action information [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.3. Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] customSensitiveConfiguration GuardedString null Custom Sensitive Configuration script for Groovy ConfigSlurper customConfiguration String null Custom Configuration script for Groovy ConfigSlurper x509Cert String null The X509 certificate supplied for authentication. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.4. Basic Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] asHost String null The FQDN of your SAP Application Server, for example sap.example.com gwHost String null SAP gateway host name gwServ String null SAP gateway service user String null SAP Logon user password GuardedString null SAP Logon password client String 000 SAP client systemNumber String 00 SAP system number language String EN SAP Logon language destination String OPENIDM SAP JCo destination name directConnection boolean true If true, direct connection to an SAP ABAP Application server or SAP router. If false connection to a group of SAP instances through an SAP message server sapRouter String null SAP router string to use for a system protected by a firewall. (/H/host[/S/port]) [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.5. SAP Jco Logs Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] trace String 0 Enable/disable RFC trace (0 or 1) cpicTrace String 0 Enable/disable CPIC trace [0..3] [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.6. Advanced Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] msHost String null Specifies the host that the message server is running on group String null Specifies the group name of the application servers, used when you log in to a logon group that uses load balancing msServ String null Name of the service where the message server can be reached r3Name String null Specifies the name of the SAP system, used when you log in to a logon group that uses load balancing [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.7. SAP Secure Network Connection Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] sncMode String 0 Flag used to activate SNC. Possible values are 0 (OFF) and 1 (ON). sncQoP String 3 Specifies the security level to use for the connection. Possible values are 1 - Authentication only, 2 - Integrity protection, 3 - Privacy protection, 8 - Use the value from snc/data_protection/use on the application server, 9 - Use the value from snc/data_protection/max on the application server sncLibrary String null Specifies the path to the external library that provides Secure Network Connection service. The default is the system-defined library as defined in the environment variable SNC_LIB. sncPartnerName String null Specifies the AS ABAP SNC name, for example, "p:CN=ABC, O=MyCompany, C=US". You can find the application server SNC name in the profile parameter snc/identity/as on the AS ABAP. sncMyName String null Specifies the connector SNC name, for example, "p:CN=OpenIDM, O=MyCompany, C=US". This parameter is optional, but you should set it to make sure that the correct SNC name is used for the connection. sncSSO String 0 Specifies whether the connection should be configured for single sign-on (SSO). Possible values are 0 (OFF) and 1 (ON). [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 9.7.8. JCo Connection Pool Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] poolCapacity String 1 Maximum number of idle connections kept open by the destination. 0 = no connection pooling. Default is 1. expirationTime String 60000 Time in ms after that a free connection can be closed. Default is one minute. maxGetTime String 30000 Maximum time in ms to wait for a connection, if the maximum allowed number of connections is allocated by the pool. Default is 30 seconds. peakLimit String 0 Maximum number of active connections that can be created for a destination simultaneously. The default is 0 (unlimited). expirationPeriod String 60000 Period in ms after that the destination checks the released connections for expiration. Default is one minute [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. # Chapter 10. SSH Connector The SSH connector is an implementation of the Scripted Groovy Connector Toolkit, and is based on Java Secure Channel (JSch) and the Java implementation of the Expect library (Expect4j). This connector lets you interact with any SSH server, using Groovy scripts for the ICF operations. The SSH connector is a poolable connector. This means that each connector instance is placed into a connection pool every time an action is completed. Subsequent actions can re-use connector instances from the connector pool. When a new connector instance is created, a new SSH client connection is created against the target SSH server. This SSH connection remains open as long as the connector instance is in the connection pool. Note that when a new action is performed, it finds the SSH connection in the exact state that it was left by the previous action. The following image shows the relationship between SSH connector instances and SSH connections to the target server: ## 10.1. Configuring Authentication to the SSH Server The SSH connector authenticates to the SSH server using either a login/password or a public/private key. The authentication method is specified in the authenticationType property in the connector configuration file (conf/provisioner.openicf-ssh.json). Authenticating with a login and password To authenticate with a login and password, set the authenticationType to PASSWORD in the connector configuration file, and set a user and password. For example: "configurationProperties" : { ... "authenticationType" : "PASSWORD", "user" : "<USERNAME>", "password" : "<PASSWORD>", ... The password is encrypted when IDM loads the provisioner file. Authenticating with a passphrase and private key To authenticate with a secure certificate, generate a pair of public/private keys. Install the public key on the server side and the private key on the IDM host (where the connector is located). Set the authenticationType to PUBKEY in the connector configuration file and set the user, password, passphrase and privateKey properties. For example: "configurationProperties" : { ... "authenticationType" : "PUBKEY", "user" : "<USERNAME>", "password" : "<PASSWORD>", "passphrase" : "secret", "privateKey" : ["-----BEGIN DSA PRIVATE KEY-----", "MIIBugIBAAKBgQDcB0ztVMCFptpJhqlLNZSdN/5cDL3S7aOVy52Ae7vwwCqQPCQr", "6NyUk+wtkDr07NlYd3sg7a9hbsEnlYChsuX+/WUIvbOKdMfeqcQ+jKK26YdkTCGj", "g86dBj9JYhobSHDoQ9ov31pYN/cfW5BAZwkm9TdpEjHPvMIaOxx7GPGKWwIVALbD", "CEuf1yJk9UB7v0dmJS7bKkbxAoGARcbAuDP4rB6MsgAAkVwf+1sHXEiGPShYWrVV", "qBgCZ/S45ELqUuiaN/1N/nip/Cc/0SBPKqwl7o50CUg9GH9kTAjmXiwmbkwvtUv+", "Xjn5vCHS0w18yc3rGwyr2wj+D9KtDLFJ8+T5HmsbPoDQ3mIZ9xPmRQuRFfVMd9wr", "DY0Rs7cCgYAxjGjWDSKThowsvOUCiE0ySz6tWggHH3LTrS4Mfh2t0tnbUfrXq2cw", "3CN+T6brgnpYbyX5XI17p859C+cw90MD8N6vvBxaN8QMDRFk+hHNUeSy8gXeem9x", "O0vdIxCgKvA4dh5nSVb5VGKENEGNEHRlYxEPzbqlPa/C/ZvzIvdKXQIUQMoidPFC", "n9z+mE2dAADnPf2m9vk=", "-----END DSA PRIVATE KEY-----" ], ... The default value for the passphrase property is null. If you do not set a passphrase for the private key, the passphrase value must be equal to an empty string. You must set a value for the password property, because the connector uses sudo to perform actions on the SSH server. The private key (PEM certificate) must be defined as a JSON String array. The values of the passphrase, password and privateKey are encrypted when IDM loads the provisioner file. ## 10.2. Configuring the SSH Connector IDM provides a sample connector configuration (provisioner.openicf-ssh.json) in the /path/to/openidm/samples/ssh/conf/ directory. You can copy the sample connector configuration to your project's conf/ directory, and adjust it to match your Kerberos environment. Set the authentication properties, as described in "Configuring Authentication to the SSH Server". In addition, set at least the following properties: host Specify the hostname or IP address of the SSH server. port Set the port on which the SSH server listens. Default: 22 user The username of the account that connects to the SSH server. This account must be able to ssh into the server, with the password provided in the next parameter. password The password of the account that is used to connect to the SSH server. prompt A string representing the remote SSH session prompt. This must be the exact prompt string, in the format username@target:, for example admin@myserver:~$ . Include any trailing spaces.

The following list describes the configuration properties of the SSH connector shown in the sample connector configuration file. You can generally use the defaults provided in the sample connector configuration file, in most cases. For a complete list of all the configuration properties of the SSH connector, see "Configuration Properties".

sudoCommand

A string that shows the full path to the sudo command, for example /usr/bin/sudo.

echoOff

If set to true (the default), the input command echo is disabled. If set to false, every character that is sent to the server is sent back to the client in the expect() call.

terminalType

Sets the terminal type to use for the session. The list of supported types is determined by your Linux/UNIX system. For more information, see the terminfo manual page ($man terminfo). Default: vt102 setLocale If set to true, indicates that the default environment locale should be changed to the value of the locale property. Default: false locale Sets the locale for the LC_ALL, LANG and LANGUAGE environment variables, if setLocale is set to true. Default: en_US.utf8 connectionTimeout Specifies the connection timeout to the remote server, in milliseconds. Default: 5000 expectTimeout Specifies the timeout used by the expect() calls in scripts, in milliseconds. Default: 5000 authenticationType Sets the authentication type, either PASSWORD or PUBKEY. For more information, see "Configuring Authentication to the SSH Server". Default: PASSWORD throwOperationTimeoutException If true, the connector throws an exception when the expectTimeout is reached for an operation. Otherwise, the operation fails silently. Default: true scriptRoots The path to the Groovy scripts that will perform the ICF operations, relative to your IDM installation directory. The sample connector configuration expects the scripts in project-dir/tools, so this parameter is set to &{idm.instance.dir}/tools in the sample configuration. classpath The directory in which the compiler should look for compiled classes. The default classpath, if not is specified, is install-dir/lib. reloadScriptOnExecution By default, scripts are loaded and compiled when a connector instance is created and initialized. Setting reloadScriptOnExecution to true makes the connector load and compile the script every time it is called. Do not set this property to true in a production environment, because it will have a significant impact on performance. Default: false *ScriptFileName The name of the Groovy script that is used for each ICF operation. ## 10.3. OpenICF Interfaces Implemented by the SSH Connector The SSH Connector implements the following OpenICF interfaces. Provides simple authentication with two parameters, presumed to be a user name and password. Creates an object and its uid. Deletes an object, referenced by its uid. Resolves an object by its username and returns the uid of the object. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Runs a script on the target resource that is managed by this connector. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 10.4. SSH Connector Configuration The SSH Connector has the following configurable properties. ### 10.4.1. Configuration Properties PropertyTypeDefault Encrypted [a] Required [b] customSensitiveConfiguration GuardedString null Description is not available createScriptFileName String null  Create Description is not available targetDirectory File null Description is not available customizerScriptFileName String null Description is not available warningLevel int 1 Description is not available authenticateScriptFileName String null  Authenticate Description is not available scriptExtensions String[] ['groovy'] Description is not available scriptOnResourceScriptFileName String null  Script On Resource Description is not available minimumRecompilationInterval int 100 Description is not available deleteScriptFileName String null  Delete Description is not available scriptBaseClass String null Description is not available scriptRoots String[] null Description is not available customConfiguration String null Description is not available resolveUsernameScriptFileName String null  Resolve Username Description is not available searchScriptFileName String null  Get Search Description is not available tolerance int 10 Description is not available updateScriptFileName String null  Update Description is not available debug boolean false Description is not available classpath String[] [] Description is not available disabledGlobalASTTransformations String[] null Description is not available schemaScriptFileName String null  Schema Description is not available verbose boolean false Description is not available testScriptFileName String null  Test Description is not available sourceEncoding String UTF-8 Description is not available syncScriptFileName String null  Sync Description is not available recompileGroovySource boolean false Description is not available [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ### 10.4.2. Basic Configuration Properties Properties PropertyTypeDefault Encrypted [a] Required [b] host String null The hostname to connect to port int 22 TCP port to use (defaults to 22) user String null The user name used to login to remote server password GuardedString null The password used to login to remote server passphrase GuardedString null The passphrase used to read the private key when using Public Key authentication privateKey String[] [] The base 64 encoded value (PEM) of the private key used for Public Key authentication authenticationType String PASSWORD Defines which authentication type should be use: PASSWORD or PUBKEY (defaults to PASSWORD) prompt String root@localhost:#  A string representing the remote SSH session prompt (defaults to root@localhost:# ) sudoCommand String /usr/bin/sudo A string representing the sudo command (defaults to /usr/bin/sudo) echoOff boolean true Disable the input command echo (default to true) terminalType String vt102 Defines the terminal type to use for the session (default to vt102) locale String en_US.utf8 Define the locale for LC_ALL, LANG and LANGUAGE environment variables to use if setLocale=true setLocale boolean false Defines if the default environment locale should be changed with the value provided for locale (defaults to false) connectionTimeout int 5000 Defines the connection timeout to the remote server in milliseconds (default to 5000) expectTimeout long 5000 Defines the timeout used by the expect() calls in the scripts in milliseconds (default to 5000) throwOperationTimeoutException boolean true Defines if an OperationTimeoutException should be thrown if any call to expect times out (defaults to true) [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. # Chapter 11. Google Apps Connector IDM bundles a Google Apps connector, along with a sample connector configuration. The Google Apps connector lets you interact with Google's web applications. The Google Apps connector is subject to the API Limits and Quotas that are imposed by Google. The connector also adheres to the implementation guidelines set out by Google for implementing exponential backoff. ## 11.1. Configuring the Google Apps Connector The Google Apps connector uses OAuth2 to authorize the connection to the Google service. To use this authorization mechanism, you must supply a clientId and clientSecret in order to obtain an access token from Google. You can obtain the clientId and clientKey from the Google Developers Console after you have configured your Web Application. A sample Google Apps connector configuration file is provided in samples/example-configurations/provisioners/provisioner.openicf-google.json The following is an excerpt of the provisioner configuration file. This example shows an excerpt of the provisioner configuration. The default location of the connector .jar is openidm/connectors. Therefore the value of the connectorHostRef property must be "#LOCAL": { "connectorHostRef": "#LOCAL", "connectorName": "org.forgerock.openicf.connectors.googleapps.GoogleAppsConnector", "bundleName": "org.forgerock.openicf.connectors.googleapps-connector", "bundleVersion": "[1.5.19.0,1.6.0.0)" },  The following excerpt shows the required configuration properties: "configurationProperties": { "domain": "", "clientId": "", "clientSecret": null, "refreshToken": null },  These configuration properties are fairly straightforward: domain Set to the domain name for OAuth 2-based authorization. clientId A client identifier, as issued by the OAuth 2 authorization server. For more information, see the following section of RFC 6749: Client Identifier. clientSecret Sometimes also known as the client password. OAuth 2 authorization servers can support the use of clientId and clientSecret credentials, as noted in the following section of RFC 6749: Client Password. refreshToken A client can use an OAuth 2 refresh token to continue accessing resources. For more information, see the following section of RFC 6749: Refresh Tokens. For a sample Google Apps configuration that includes OAuth 2-based entries for configurationProperties, see "Synchronizing Accounts With the Google Apps Connector" in the Samples Guide. ## 11.2. OpenICF Interfaces Implemented by the GoogleApps Connector The GoogleApps Connector implements the following OpenICF interfaces. Creates an object and its uid. Deletes an object, referenced by its uid. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Searches the target resource for all objects that match the specified object class and filter. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 11.3. GoogleApps Connector Configuration The GoogleApps Connector has the following configurable properties. ### 11.3.1. Basic Configuration Properties Properties PropertyTypeDefault Encrypted [a] Required [b] domain String null Internet domain name. See https://support.google.com/a/answer/177483?hl=en clientId String null Client identifier issued to the client during the registration process. clientSecret GuardedString null Client secret issued to the client during the registration process. refreshToken GuardedString null The refresh token allows you to get a new access token that is good for another hour. Refresh tokens never expire, they can only be revoked by the user or programatically by your app. proxyHost String null Defines an HTTP proxy host to use with the connection (example: "myproxy.home.com"). proxyPort int 8080 Defines an HTTP proxy port to use with the connection (defaults to 8080). validateCertificate boolean true Validate the server certificate from the local truststore (defaults to true). usersMaxResults int 100 Maximum number of Users to return. Acceptable values are 1 to 500, inclusive. groupsMaxResults int 200 Maximum number of Groups to return. Acceptable values are 1 to 200, inclusive. membersMaxResults int 200 Maximum number of Members to return. Acceptable values are greater than 1 listProductMaxResults long 100 Maximum number of Licenses to return. Acceptable values are 1 to 1000, inclusive. listProductAndSkuMaxResults long 100 Maximum number of Licenses to return. Acceptable values are 1 to 1000, inclusive. [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. ## 11.4. Using the Google Apps Connector With a Proxy Server If the IDM server is hosted behind a firewall and requests to the Google Apps server are routed through a proxy, you must specify the proxy host and port in the connector configuration so that the connector can pass this information to the lower Google API. To specify the proxy server details, set the proxyHost, proxyPort and validateCertificate properties in the connector configuration. For example: "configurationProperties": { ... "proxyHost": "myproxy.home.com", "proxyPort": 8080, "validateCertificate": true, ... },  The validateCertificate property indicates whether the proxy server should validate the server certificate from the local truststore. ## 11.5. Supported Resource Types The Google Apps connector uses the Google Enterprise License Manager and Directory APIs to perform CRUD operations against resources within a Google Apps domain. The following table lists the resource types that are supported by the Google Apps connector: Supported Resource Types With the Google Apps Connector ICF Native TypeGoogle Resource TypeNaming Attribute __ACCOUNT__userprimaryEmail __GROUP__groupemail Membermember{groupKey}/email OrgUnitorgUnit{parentOrgUnitPath}/__NAME__ LicenseAssignmentlicenseAssignment{productId}/sku/{skuId}/user/{primaryEmail} ## 11.6. Functional Limitations The Google Apps connector is subject to the following functional limitations: • The connector does not implement the ICF Sync operation so you cannot use the connector for liveSync of supported Google Apps resources to IDM managed objects. • The connector does not implement the Authenticate operation so you cannot use the connector to perform pass-through authentication between IDM and a Google Apps domain. You can also not use this connector to perform password Change operations (as opposed to password Reset) because the connector cannot authenticate on behalf of the end user. • Support for Filters when performing Search operations is limited to those attributes described in "Supported Search Filters". • Google Apps creates a new User Alias each time the primaryEmail address associated with the User object is modified. You cannot delete User Aliases with the Google Apps connector so you must manage Aliases directly from within the Google Apps console. • The Google Apps connector does not support custom schemas. The connector is therefore not able to read or update attributes associated with custom schemas in your Google Apps domain. • For PATCH requests, a connector can potentially add, remove, or replace an attribute value. The Google Apps connector does not implement the add or remove operations, so a PATCH request always replaces the entire attribute value with the new value. ## 11.7. Supported Search Filters The Google Apps connector supports filtered searches against Google Apps resources. However, limitations imposed by the APIs provided by the Google Apps Admin SDK prevent filtering of resource types based on arbitrary attributes and values. The following filter operators and attributes are supported for Search operations with the Google Apps connector: Supported Operators and Filter Attributes With Google Apps Searches Object TypeOperatorsAttributes __ACCOUNT__And, Contains, StartsWith, EqualsprimaryEmail __GROUP__Contains, Equalsemail MemberEquals{groupKey}/email OrgUnitStartsWith{parentOrgUnitPath}/__NAME__ LicenseAssignmentEquals{productId}/sku/{skuId}/user/{primaryEmail} # Chapter 12. Kerberos Connector The Kerberos connector is an implementation of the SSH connector, and is based on Java Secure Channel (JSch) and the Java implementation of the Expect library (Expect4j). The connector depends on the following files, provided with IDM: • /path/to/openidm/lib/ssh-connector-1.5.19.1.jar • /path/to/openidm/lib/expect4j-<version>.jar • /path/to/openidm/lib/jsch-<version>.jar  The Kerberos connector lets you manage Kerberos user principals from IDM. The connector is provided in /path/to/openidm/connectors/kerberos-connector-1.5.19.1.jar and bundles a number of Groovy scripts to interact with a Kerberos admin server. Users of the Kerberos connector are not expected to edit the bundled Groovy scripts. The bundled scripts use the kadmin utility to communicate with the Kerberos server. The Kerberos connector lets you perform the following operations on Kerberos user principals. • List the existing principals • Display the details of a principal • Add a user principal • Change the password of a user principal and unlock the principal • Delete a user principal ## 12.1. Kerberos Connector Schema The Kerberos connector can only be used to manage the Kerberos principal object type (which maps to the ICF __ACCOUNT__ object). The following attributes are supported in the schema: • principal - (maps to __NAME__ and __UID__) • __PASSWORD__ - updatable, required when an object is created • __LOCK_OUT__ - updatable only; unlock an account by setting this attribute to false • policy - the password policy used by the principal • expirationDate - the date that the user principal expires • passwordExpiration - the date that the password expires • maximumTicketLife - the maximum ticket life for the principal. At the end of the ticket lifetime, the ticket can no longer be used. However, if the renewable lifetime (maximumRenewableLife) is longer than the ticket lifetime, the ticket holder can present the ticket to the KDC and request a new ticket. • maximumRenewableLife - the period during which the ticket can be renewed. A renewed ticket usually has a new ticket lifetime, dating from the time that it was renewed, that is constrained by the renewable ticket lifetime. In addition, the following read-only attributes are supported: • lastPasswordChange • lastModified • lastSuccessfulAuthentication • lastFailedAuthentication • failedPasswordAttempts ## 12.2. Configuring the Kerberos Connector A sample connector configuration (provisioner.openicf-kerberos.json) is provided in the /path/to/openidm/samples/sync-with-kerberos/conf/ directory. You can copy the sample connector configuration to your project's conf/ directory, and adjust it to match your Kerberos environment. Set the authentication properties, as described in "Configuring Authentication to the SSH Server". In addition, set at least the following properties: customConfiguration Specify the details of the user principal and the default realm here. The sample provisioner file has the following custom configuration: "customConfiguration" : "kadmin{ cmd = '/usr/sbin/kadmin.local'; user = '<KADMIN USERNAME>'; default_realm = '<REALM, e.g. EXAMPLE.COM>' }", A complete custom configuration will look something like this: "customConfiguration" : "kadmin { cmd = '/usr/sbin/kadmin.local'; user = 'openidm/admin'; default_realm = 'EXAMPLE.COM' }", customSensitiveConfiguration Set the password for the user principal here. The sample provisioner has the following configuration: "customSensitiveConfiguration" : "kadmin { password = '<KADMIN PASSWORD>'}", Change this to reflect your user principal password, for example: "customSensitiveConfiguration" : "kadmin { password = 'Passw0rd'}" The following section describes the configuration parameters in the sample Kerberos connector configuration. For a complete list of the configuration properties for the Kerberos connector, see "Configuration Properties": host The host name or IP address of the SSH server on which the kadmin command is run. port The port number on which the SSH server listens. Default: 22 (the default SSH port) user The username of the account that is used to connect to the SSH server. ### Note This is not the same as your Kerberos user principal. This account must be able to ssh into the server on which Kerberos is running, with the password provided in the next parameter. password The password of the account that is used to connect to the SSH server. prompt A string representing the remote SSH session prompt. This must be the exact prompt string, in the format username@target:, for example root@localhost:~$ .

If the prompt includes a trailing space, you must include the space in the value of this property.

Consider customizing your Linux prompt with the PS1 and PS2 variables, to set a safe prompt. For information about customizing promtps, see this article.

sudoCommand

A string that shows the full path to the sudo command, for example /usr/bin/sudo.

echoOff

If set to true (the default), the input command echo is disabled. If set to false, every character that is sent to the server is sent back to the client in the expect() call.

terminalType

$./startup.sh 2. Log in to the Admin UI at https://localhost:8443/admin (substitute localhost for the host on which your IDM instance is running). 3. Select Configure > Connectors, and click New Connector. 4. Enter a Connector Name (for example, Salesforce) and select Salesforce Connector - 1.5.19.1 as the Connector Type. 5. Supply the Login URL, Consumer Key, Consumer Secret and click Save. The Login URL is the OAuth endpoint that will be used to make the OAuth authentication request to Salesforce. 6. Select Save to update the connector configuration. The connector now attempts to access your Salesforce organization. Enter your Salesforce login credentials. On the permission request screen click Allow, to enable IDM to access your Salesforce Connected App. 7. When your connector is configured correctly, the connector displays as Active in the UI. To Configure the Salesforce Connector With a Configuration File 1. IDM provides a sample connector configuration file in the /path/to/openidm/samples/example-configurations/provisioners directory. Copy this sample file (provisioner.openicf-salesforce.json) to your project's conf directory, and set at least the following properties: "configurationProperties" : { "loginUrl" : "loginURL", "clientSecret" : "clientSecret", "clientId" : "clientId", "refreshToken" : "refreshToken" "instanceUrl" : "instanceURL", } loginUrl The OAuth endpoint that will be used to make the OAuth authentication request to Salesforce. The default endpoint for a production system is https://login.salesforce.com/services/oauth2/token. The default endpoint for a sandbox (test) system is https://test.salesforce.com/services/oauth2/token. clientSecret The Consumer Secret associated with your Connected App. clientId The Consumer Key associated with your Connected App. refreshToken and instanceURL The Admin UI obtains these properties on your behalf. If you are configuring the connector manually, obtain the refresh token and instance URL from salesforce.com as follows: 1. Point your browser to the following URL: SALESFORCE_URL/services/oauth2/authorize?response_type=code&client_id=CONSUMER_KEY&redirect_uri=REDIRECT_URI&scope=id+api+refresh_token Where: • SALESFORCE_URL is one of the following: • A production URL (https://login.salesforce.com) • A sandbox URL (https://test.salesforce.com) • A custom Salesforce MyDomain URL, such as: https://ic-example-com--SUP1.cs21.my.salesforce.com • CONSUMER_KEY is the Consumer Key associated with the Connected App that you created within your Salesforce organization. • REDIRECT_URI is the IDM URI Salesforce should redirect to during authentication. It must match the Redirect URI specified within your Salesforce Connect App configuration, for example: https://localhost:8443/ 2. You are redirected to Salesforce, and prompted to give this application access to your Salesforce account. When you have given consent, you should receive a response URL that looks similar to the following: https://localhost:8443/admin/index.html#connectors/edit//&code=aPrxJZTK7Rs03PU634VK8Jn9o_U3ZY1ERxM7IiklF... The &code part of this URL is an authorization code, that you need for the following step. ### Caution This authorization code expires after 10 minutes. If you do not complete the OAuth flow within that time, you will need to start this process again. 3. Copy the authorization code from the response URL and use it as the value of the code parameter in the following REST call. The consumer-key, redirect-uri, and SALESFORCE_URL must match what you used in the first step of this procedure: $  curl \
--verbose \
--data "grant_type=authorization_code" \
--data "client_id=consumer-key" \
--data "client_secret=consumer-secret" \
--data "redirect_uri=https://localhost:8443/" \
--data "code=access-token-code" \
"SALESFORCE_URL/services/oauth2/token"
{
"access_token": "00DS0000003K4fU!AQMAQOzEU.8tCjg8Wk79yKPKCtrtaszX5jrHtoT4NBpJ8x...",
"signature": "2uREX1lseXdg3Vng/2+Hrlo/KHOWYoim+poj74wKFtw=",
"refresh_token": "5Aep861KIwKdekr90I4iHdtDgWwRoG7O_6uHrgJ.yVtMS0UaGxRqE6WFM77W7...",
"token_type": "Bearer",
"instance_url": "https://example-com.cs1.my.salesforce.com",
"scope": "id api refresh_token",
"issued_at": "1417182949781",
}

The output includes the refresh_token and the instance_url that you need to configure the connector.

2. Set "enabled" : true to enable the connector.

3. Save the connector configuration.

4. Test that the configuration is correct by running the following command:

$curl \ --header "X-OpenIDM-Username: openidm-admin" \ --header "X-OpenIDM-Password: openidm-admin" \ --request POST \ "http://localhost:8080/openidm/system/salesforce?_action=test" { "name": "salesforce", "enabled": true, "config": "config/provisioner.openicf/salesforce", "connectorRef": { "bundleVersion": "[1.5.19.0,1.6.0.0)", "bundleName": "org.forgerock.openicf.connectors.salesforce-connector", "connectorName": "org.forgerock.openicf.connectors.salesforce.SalesforceConnector" }, "displayName": "Salesforce Connector", "objectTypes": [ "__ALL__", "User" ], "ok": true } If the command returns "ok": true, your connector has been configured correctly, and can authenticate to Salesforce. ## 13.3. Implementation Specifics For PATCH requests, a connector can potentially add, remove, or replace an attribute value. The Salesforce connector does not implement the add or remove operations, so a PATCH request always replaces the entire attribute value with the new value. Salesforce does not support multi-valued attributes. Attributes themselves cannot be removed from Salesforce. The connector therefore performs an update with "" as the value of the attribute being removed. This sets the value of the removed attribute to null. ### Note Salesforce does not support application user DELETE requests. ## 13.4. OpenICF Interfaces Implemented by the Salesforce Connector The Salesforce Connector implements the following OpenICF interfaces. Creates an object and its uid. Deletes an object, referenced by its uid. Describes the object types, operations, and options that the connector supports. Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics: • The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access. • The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration. • The script has access to any script-arguments passed in by the application. Searches the target resource for all objects that match the specified object class and filter. Polls the target resource for synchronization events, that is, native changes to objects on the target resource. Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid. This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out). You can invoke the test operation before a connector configuration has been validated. Updates (modifies or replaces) objects on a target resource. ## 13.5. Salesforce Connector Configuration The Salesforce Connector has the following configurable properties. ### 13.5.1. Basic Configuration Properties Properties PropertyTypeDefault Encrypted [a] Required [b] clientId String null The client identifier clientSecret GuardedString null The secure client secret for OAUTH refreshToken GuardedString null The refresh token for the application loginUrl String https://login.salesforce.com/services/oauth2/token The endpoint from which a new access token should be queried (https://login.salesforce.com/services/oauth2/token) instanceUrl String null The URL of the Salesforce instance (such as https://example-com.cs1.my.salesforce.com) version double 48.0 The Salesforce API version connectTimeout long 120000 The maximum connection timeout proxyHost String null The hostname of an http proxy, used between the connector and the Salesforce service provider proxyPort Integer 3128 The proxy port number, if an HTTP proxy is used between the connector and the Salesforce service provider maximumConnections int 10 The maximum size of the HTTP connection pool supportedObjectTypes String[] [] Defines a list of Salesforce objects that will be used to dynamically build the provisioner schema proxyUri String null The URI of an HTTP proxy that contains the scheme, host, and port number for that proxy proxyUsername String null The proxy username to use with a proxy that requires authentication proxyPassword GuardedString null The proxy user password to use with a proxy that requires authentication [a] Indicates whether the property value is considered confidential, and therefore encrypted in OpenIDM. [b] A list of operations in this column indicates that the property is required for those operations. # Chapter 14. Marketo Connector The Marketo connector enables synchronization between IDM managed users and a Marketo leads database. This connector forms part of ForgeRock's support for customer data management (CDM). You can synchronize any managed user to Marketo—those who have been added directly to the IDM repository, and those who have registered themselves through one of the Social Identity Providers described in "Configuring Social Identity Providers" in the Integrator's Guide. The Marketo connector is an implementation of the Scripted Groovy Connector Toolkit, and lets you interact with leads in a Marketo database, using Groovy scripts for the ICF operations. To use the Marketo connector, you need the following: • A Marketo account • A client ID and client secret • The REST API URL for your IDM service • A custom list created in your Marketo leads database To obtain these details from Marketo, see the Marketo documentation. A sample connector configuration file is available, at /path/to/openidm/samples/example-configurations/provisioners/provisioner.openicf-marketo.json. To test the Marketo connector, copy that file to your project's conf/ directory, and edit at least the configurationProperties to provide the REST API URL, client ID and client secret. Set the enabled property in the connector configuration to true. IDM encrypts the client secret on startup. Optionally, you can specify the listName to which leads should be added when they are synchronized from IDM. The following excerpt from the sample connector configuration file shows the properties that you must set: { "displayName" : "MarketoConnector", "description" : "Connector used to sync users to Marketo leads", "author" : "ForgeRock", "enabled" : true, "connectorRef" : { "bundleName" : "org.forgerock.openicf.connectors.marketo-connector", "bundleVersion" : "[1.5.19.0,1.6.0.0)", "connectorName" : "org.forgerock.openicf.connectors.marketo.MarketoConnector" }, ... "configurationProperties" : { "instance" : "<INSTANCE_FQDN>", "clientId" : "<CLIENT_ID>", "clientSecret" : "<CLIENT_SECRET>", "leadFields" : null, "partitionName" : null, "listName" : "<LEAD_LIST_NAME>", ... instance To locate the REST API endpoint URL in Marketo, select Admin > Web Services, scroll down to REST API, and find the endpoint. Use that REST endpoint as the value of the instance property in your connector configuration. Remove the protocol and /rest from the URL. For example, if the endpoint is https://some-number.mktorest.com/rest, the value of the instance property must be some-number.mktorest.com. clientId Locate the client ID in the details of your Marketo service LaunchPoint. clientSecret Locate the client secret in the details of your Marketo service LaunchPoint. listName The name of the custom list created in your Marketo Leads database. You can also configure the Marketo connector through the Admin UI. Select Configure > Connectors > New Connector and select Marketo Connector - 1.5.19.1 as the Connector Type. Configuration properties correspond to those described in the previous list. For details of all the configuration properties, see "Marketo Connector Configuration". When your connector is configured correctly, you can test its status by running the following command: $ curl \
--request POST \
"http://localhost:8080/openidm/system?_action=test"
[
{
"name": "marketo",
"enabled": true,
"config": "config/provisioner.openicf/marketo",
"objectTypes": [
"__ALL__",
"account"
],
"connectorRef": {
"bundleName": "org.forgerock.openicf.connectors.marketo-connector",
"connectorName": "org.forgerock.openicf.connectors.marketo.MarketoConnector",
"bundleVersion": "[1.5.19.0,1.6.0.0)"
},
"displayName": "Marketo Connector",
"ok": true
}
]


A status of "ok": true indicates that the connector can reach your Marketo database.

## 14.1. Reconciling Users With a Marketo Leads Database

The Marketo connector lets you reconcile IDM users (including managed users and users who have registered through a social identity provider) with a Marketo leads database. To set up reconciliation to a Marketo database, copy the following sample mapping file to your project's conf directory:

/path/to/openidm/samples/example-configurations/marketo/sync.json

This file sets up a mapping from the managed user repository to Marketo user accounts. The file includes transformations for user accounts registered through Facebook and LinkedIn. You can use these transformations as a basis for transformations from other social identity providers.

If you have an existing mapping configuration (sync.json), add the content of this sample sync.json to your existing file.

The sample mapping restricts reconciliation to users who have accepted the marketing preferences with the following validSource script:

"validSource" : {
"type" : "text/javascript",
"globals" : {
"preferences" : [
"marketing"
]
},
"file" : "ui/preferenceCheck.js"
}

When a user registers with IDM, they can choose to accept this condition. As a regular user, they can also select (or deselect) the condition in the End User UI by logging into IDM at http://localhost:8080/, and selecting Preferences.

If a user deselects the marketing preference after their account has been reconciled to Marketo, the next reconciliation run will remove the account from the Marketo database.

For more information on how preferences work in a mapping, see "Configuring Synchronization Filters With User Preferences" in the Integrator's Guide.

## 14.2. Implementation Specifics

For PATCH requests, a connector can potentially add, remove, or replace an attribute value. The Marketo connector does not implement the add or remove operations, so a PATCH request always replaces the entire attribute value with the new value.

## 14.3. OpenICF Interfaces Implemented by the Marketo Connector

The Marketo Connector implements the following OpenICF interfaces.

Provides simple authentication with two parameters, presumed to be a user name and password.

Creates an object and its uid.

Deletes an object, referenced by its uid.

Resolves an object by its username and returns the uid of the object.

Describes the object types, operations, and options that the connector supports.

Enables an application to run a script in the context of the connector. Any script that runs on the connector has the following characteristics:

• The script runs in the same execution environment as the connector and has access to all the classes to which the connector has access.

• The script has access to a connector variable that is equivalent to an initialized instance of the connector. At a minimum, the script can access the connector configuration.

• The script has access to any script-arguments passed in by the application.

Runs a script on the target resource that is managed by this connector.

Searches the target resource for all objects that match the specified object class and filter.

Polls the target resource for synchronization events, that is, native changes to objects on the target resource.

Tests the connector configuration. Testing a configuration checks all elements of the environment that are referred to by the configuration are available. For example, the connector might make a physical connection to a host that is specified in the configuration to verify that it exists and that the credentials that are specified in the configuration are valid.

This operation might need to connect to a resource, and, as such, might take some time. Do not invoke this operation too often, such as before every provisioning operation. The test operation is not intended to check that the connector is alive (that is, that its physical connection to the resource has not timed out).

You can invoke the test operation before a connector configuration has been validated.

Updates (modifies or replaces) objects on a target resource.

## 14.4. Marketo Connector Configuration

The Marketo Connector has the following configurable properties.

### 14.4.1. Configuration Properties

PropertyTypeDefault Encrypted [a] Required [b]
customSensitiveConfiguration GuardedString null

Custom Sensitive Configuration script for Groovy ConfigSlurper

customConfiguration String null

Custom Configuration script for Groovy ConfigSlurper

instance String null

The Marketo-assigned FQDN for your instance

clientId String null