3.2 Advanced Settings Parameters

Advanced configuration parameters vary depending on whether you are creating a target application or an authoritative application.

3.2.1 Advanced Settings Parameters

These are the configuration-related entries that the connector uses during reconciliation and provisioning operations.

Table 3-2 Advanced Settings Parameters

Parameter Mandatory? Description
relURIs Yes

This entry holds the relative URL of every object class supported by this connector and the connector operations that can be performed on these object classes.

Sample value:

"__ACCOUNT__.CREATEOP=/users","__ACCOUNT__.UPDATEOP=/users/$(__UID__)$","__ACCOUNT__.TESTOP=/users","__ACCOUNT__.SEARCHOP=/users?$(Filter Suffix)$&additional_info=true&count=$(PAGE_SIZE)$&status=Active,ActivationRequired,ActivationSent","__ACCOUNT__.DELETEOP=/users","__PROFILE__.SEARCHOP=/permission_profiles","groupList.SEARCHOP=/groups","__SIGNING__.SEARCHOP=/signing_groups","__ACCOUNT__.groupList.UPDATEOP=/groups/$(groupList.groupId)$/users","__ACCOUNT__.signingGroupId.UPDATEOP=/signing_groups/$(signingGroupId)$/users","__ACCOUNT__.groupList.REMOVEATTRIBUTE=/groups/$(groupList~groupList~groupId)$/users","__ACCOUNT__.signingGroupId.REMOVEATTRIBUTE=/signing_groups/$(signingGroupId)$/users","__ACCOUNT__.signingGroupId.SEARCHOP=/signing_groups/$(signingGroupId)$/users","__ACCOUNT__.groupList.SEARCHOP=/users/$(__UID__)$"

nameAttributes No

This entry holds the namehelpText="Target attribute for all the objects that are handled by this connector. For example, __NAME__ for the __ACCOUNT__each object class that it used for User accounts, the name attribute is user_name."

Sample value:

"__ACCOUNT__.email","groupList.groupName","__PROFILE__.permissionProfileName","__SIGNING__.groupName"

uidAttributes No

This entry holds the uidhelpText="Target attribute for all the objects that are handled by this connector. For example, __UID__ for each object class.

Sample value:

"__ACCOUNT__.userId","groupList.groupId","__PROFILE__.permissionProfileId","__SIGNING__.signingGroupId"

Bundle Name Yes

This entry holds the name of the connector bundle.

Sample value:

org.identityconnectors.genericrest

Note:

Do not modify this entry.
Bundle Version Yes

This entry holds the version of the connector bundle.

Sample value:

12.3.0

Note:

Do not modify this entry.
Connector Name No

This entry holds the name of the connector.

Sample value:org.identityconnectors.genericrest.GenericRESTConnector

opTypes No

This entry specifies the HTTP operation type for each object class supported by the connector. Values are comma separated and are in the following format: OBJ_CLASS.OP=HTTP_OP In this format, OBJ_CLASS is the connector object class, OP is the connector operation (for example, CreateOp, UpdateOp, SearchOp), and HTTP_OP is the HTTP operation (GET, PUT, or POST).

Sample value:

"__ACCOUNT__.CREATEOP=POST","__ACCOUNT__.UPDATEOP=PUT","__ACCOUNT__.DELETEOP=DELETE","groupList.SEARCHOP=GET","__PROFILE__.SEARCHOP=GET","__SIGNING__.SEARCHOP=GET","__ACCOUNT__.SEARCHOP=GET","__ACCOUNT__.TESTOP=GET","__ACCOUNT__.groupList.UPDATEOP=PUT","__ACCOUNT__.signingGroupId.UPDATEOP=PUT","__ACCOUNT__.groupList.REMOVEATTRIBUTE=DELETE","__ACCOUNT__.signingGroupId.REMOVEATTRIBUTE=DELETE","__ACCOUNT__.signingGroupId.SEARCHOP=GET","__ACCOUNT__.groupList.SEARCHOP=GET"

pageSize No

This entry holds how many resources appears on a page for a search operation.

Sample value: 100

jsonResourcesTag No

This entry holds the json tag value that is used during reconciliation for parsing multiple entries in a single payload.

Sample value:

"__ACCOUNT__=users;newUsers","groupList=groups","__SIGNING__=groups","__PROFILE__=permissionProfiles"

httpHeaderContentType No

This entry holds the content type expected by the target system in the header.

Sample value: application/json

httpHeaderAccept No

This entry holds the accept type expected from the target system in the header.

Sample value: application/json

specialAttributeTargetFor No

This entry lists the format in which an attribute is present in the target system endpoint. Values are comma separated and are presented in the following format: OBJ_CLASS.ATTR_NAME= TARGET_FORMAT.

Sample value: "__ACCOUNT__.groupList=groupList"

Special AttributeHandling No

This entry lists the special attributes whose values should be sent to the target one by one ("SINGLE"). Values are comma separated and are in the following format: OBJ_CLASS.ATTR_NAME.PROV_OP=SINGLE .

Sample value:

"__ACCOUNT__.groupList.SEARCHOP=SINGLE","__ACCOUNT__.groupList.ADDATTRIBUTE=SINGLE"

Custompayload No

This entry lists the payloads for all operations that are not in the standard format.

Sample value: "__ACCOUNT__.CREATEOP={\"newUsers\":[{\"userName\":\"$(userName)$\",\"email\":\"$(__NAME__)$\",\"password\":\"$(__PASSWORD__)$\",\"firstName\":\"$(firstName)$\",\"lastName\":\"$(lastName)$\",\"company\":\"$(company)$\",\"permissionProfileId\":\"$(permissionProfileId)$\"}]}","__ACCOUNT__.DELETEOP={\"users\":[{\"userId\":\"$(__UID__)$\"}]}","__ACCOUNT__.groupList.UPDATEOP={\"users\":[{\"userId\":\"$(__UID__)$\"}]}","__ACCOUNT__.signingGroupId.UPDATEOP={\"users\":[{\"userName\":\"$(userName)$\",\"email\":\"$(__NAME__)$\"}]}","__ACCOUNT__.groupId.REMOVEATTRIBUTE={\"users\":[{\"userId\":\"$(__UID__)$\"}]}","__ACCOUNT__.signingGroupId.REMOVEATTRIBUTE={\"users\":[{\"userName\":\"$(userName)$\",\"email\":\"$(__NAME__)$\"}]}"

passwordAttribute No

This entry holds the name of the target system attribute that is mapped to the __PASSWORD__ attribute .

Sample value: password

childFieldsWithSingleEnd

No

This entry specifies special attribute data coming in from a single end-point response.

Sample value: "__ACCOUNT__.groupList"

pageUrlAttribute No

This entry specifies the JSON response attribute, which is used to paginate to the next set of records.

Sample value: nextUri