Skip Headers
Oracle® Identity Manager API Usage Guide
Release 9.0
Part Number B32144-01
Go to Documentation Home
Home		 Go to Table of Contents
Contents
Go to previous page
Previous		 Go to next page
Next
View PDF

2 What's New

This chapter contains the following sections:

New APIs in Release 9.0.2.0

Table 2-1 lists the new application programming interfaces (APIs) that were added in Release 9.0.2.0.

Table 2-1 New APIs in Release 9.0.2.0

Operation API

User

public tcResultSet findAllUsersFiltered(Map phAttributeList, String[] pasFieldList) throws tcAPIException

User

public tcResultSet getSelfProfileFiltered(String []pasFieldList) throws tcAPIException

New APIs in Release 9.0.1.1

Table 2-2 lists the new application programming interfaces (APIs) that were added in Release 9.0.1.1.

Table 2-2 New APIs in Release 9.0.1.1

Operation API

Group

public tcResultSet getAllMemberUsersAndGroups(long groupKey) throws tcGroupNotFoundException, tcAPIException

Audit

public String[] getUsersWithNoSnapshots() throws tcAPIException

New APIs in Release 9.0.1.0

Table 2-3 lists the new application programming interfaces (APIs) that were added in Release 9.0.1.0.

Table 2-3 New APIs in Release 9.0.1.0

Operations APIs

ITResource Instance

 
public HashMap getITResourceInstances(String psITResourceType) throws tcAPIException

Provisioning

 
public Date getProvisioingProcessOfflinedDate(long processInstanceKey) throws tcAPIException

Reconciliation

 
public long addDirectMultiAttributeData(long plReconciliationEventKey, String psFieldName, Map poData, String psDateFormat) 
throws tcAPIException, tcEventNotFoundException, tcEventDataReceivedException

public long addDirectMultiAttributeData(long plReconciliationEventKey, 
long plReconciliationAttributeKey, String psFieldName, Map poData, String psDateFormat) 
throws tcAPIException, tcEventNotFoundException, tcAttributeNotFoundException, tcEventDataReceivedException, tcInvalidAttributeException

public long addDirectMultiAttributeData(long plReconciliationEventKey, 
long plReconciliationAttributeKey, String psFieldName, Map poData) 
throws tcAPIException, tcEventNotFoundException, tcAttributeNotFoundException, tcEventDataReceivedException, tcInvalidAttributeException

public long addDirectMultiAttributeData(long plReconciliationEventKey, String psFieldName, Map poData) 
throws tcAPIException, tcEventNotFoundException, tcEventDataReceivedException

Audit

 
public void reIssueAuditMessageByIdentifier(String auditor, String identifier) throws tcAPIException

public void reIssueAuditMessage(int audJmsKey) throws tcAPIException

Modified APIs in Release 9.0.2.0

Table 2-4 lists the form definition operation operation APIs that were modified in Release 9.0.2.0.

Table 2-4 Modified Form Definition Operation APIs in Release 9.0.2.0

API Changes

tcDataSetData getFormFieldsData(long plFormKey, int plVersion) throws tcAPIException, tcFormNotFoundException

When a form field specifies a value for a lookup code, a new LookupCode column is returned in the result set along with its corresponding value.

Table 2-5 lists the lookup operation APIs that were modified in Release 9.0.2.0.

Table 2-5 Modified Lookup Operation APIs in Release 9.0.2.0

API Changes

public tcResultSet getLookupValues(String psLookupCode, Map poFilters) throws tcAPIException, tcInvalidLookupException

Along with the lookup values, the returned result set also contains the lookup code that was originally passed to the API.

public String getLookupCodeForColumn(String psColumnCode) throws tcAPIException, tcInvalidColumnException, tcNoLookupException

The API now returns lookup codes in user-defined fields or columns from the database and also determines whether the column is defined in the XML files. If no lookup codes are found for a user-defined column, the API also determines whether the lookup exists in the sdp_property_name column. Some error-level logger statements have also been converted to debug level statements.

Table 2-6 lists the import operation APIs that were modified in Release 9.0.2.0.

Table 2-6 Modified Import Operation APIs in Release 9.0.2.0

API Changes

public void addSubstitution(RootObject robj, String name) throws DDMException, SQLException

When SubstitutionFailedException is thrown, it now gives the error code and the object name/type related to the error along with a message.

public Collection findITResourceTypeParams(RootObject obj) throws SQLException, DDMException

An additional check now returns IT Resource parameters only when the passed object is in the DBCREATE state (present in the target database).

public FilePreview getFilePreview(String filename, String content) throws DDMException, TransformationException

Parses the contents of the passed file in UTF-8 encoding instead of the default system encoding.

Table 2-7 lists the email operation APIs that were modified in Release 9.0.2.0.

Table 2-7 Modified Email Operation APIs in Release 9.0.2.0

API Changes

public tcResultSet findEmailDefinition(Map phAttributeList) throws tcAPIException

Email definition language and country are now returned in the result set.

Table 2-8 lists the object operation APIs that were modified in Release 9.0.2.0.

Table 2-8 Modified Object Operation APIs in Release 9.0.2.0

API Changes

public tcResultSet getAssociatedOrganizations(long objectKey, Map attributeMap) throws tcObjectNotFoundException, tcAPIException

Fixed a bug where duplicate rows were returned in certain cases. Also modified to allow single quotes in object names.

public tcResultSet getAssociatedUsers(long objectKey, Map attributeMap) throws tcObjectNotFoundException, tcAPIException

Fixed a bug where duplicate rows were returned in certain cases. Also modified to allow single quotes in object names.

public tcResultSet findObjects(Map phAttributeList) throws tcAPIException

Modified to allow single quotes in object names.

public tcResultSet findProvisionableObjects(Map moAttributeMap) throws tcAPIException {

Modified to allow single quotes in object names.

Table 2-9 lists the provisioning operation APIs that were modified in Release 9.0.2.0.

Table 2-9 Modified Provisioning Operation APIs in Release 9.0.2.0

API Changes

public tcResultSet getProvisioningTaskDetails(long taskInstanceKey) throws tcAPIException

Enhanced to return the process name along with existing information

public tcResultSet getProvisioningTasksAssignedToManagedUsers(long userKey, Map attributeList, String[] statuses) throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException {

Modified to allow single quotes in the attributeList parameter.

Table 2-10 lists the request operation APIs that were modified in Release 9.0.2.0.

Table 2-10 Modified Request Operation APIs in Release 9.0.2.0

API Changes

public String createProfileModifyRequest(Map attrs) throws tcRequiredDataMissingException, tcAPIException, tcOrganizationNotFoundException, tcInvalidManagerException, tcDuplicateUserException, tcDataAccessException

Now uses UTF-8 format to encrypt and decrypt the attribute values. A tcDataAccessException was also added.

public void updateRegistrationUserDetails(long pnRequestKey, Map poAttributes) throws tcRequestInvalidException, tcOrganizationNotFoundException, tcAPIException, tcInvalidManagerException, tcDuplicateUserException, tcDataAccessException

Now uses UTF-8 format to encrypt and decrypt the attribute values. A tcDataAccessException was also added.

public tcResultSet findRequests(Map phAttributeList) throws tcAPIException

Modified to allow single quotes in the phAttributeList parameter.

public tcResultSet getApprovalTasksAssigned(Map phAttributeList) throws tcAPIException, tcAttributeNotFoundException

Enhanced to improve performance and modified to allow single quotes in the phAttributeList parameter.

public tcResultSet getApprovalTasksAssignedToManagedUsers(long userKey, Map attributeList

Modified to allow single quotes in the phAttributeList parameter.

public tcResultSet getApprovalTasksAssignedToUser(long userKey, Map phAttributeList

Modified to allow single quotes in the phAttributeList parameter.

public tcResultSet getRequestsForObject(String psObjectName, String[] pasStatus) throws tcAPIException, tcObjectNotFoundException

Modified to allow single quotes in the psObjectName parameter.

Table 2-11 lists the IT resource instance operation APIs that were modified in Release 9.0.2.0.

Table 2-11 Modified IT Resource Instance Operation APIs in Release 9.0.2.0

API Changes

public tcDataSetData findITResourceInstances(tcMapping[] paoAttributeList) throws tcAPIException

During encryption of the IT resource parameter definition to get the IT resource property name, the passed value is now encrypted using UTF-8.

Table 2-12 lists the user operation APIs that were modified in Release 9.0.2.0.

Table 2-12 Modified User Operation APIs in Release 9.0.2.0

API Changes

public long createUser(Map phMapping) throws tcAPIException, tcDuplicateUserException, tcAttributeMissingException, tcInvalidAttributeException

Modified to allow single quotes in user IDs.

public tcResultSet findAllUsers(Map phAttributeList) throws tcAPIException

Modified to allow single quotes in user IDs.

public tcResultSet findUsers(Map phAttributeList) throws tcAPIException

Modified to allow single quotes in user IDs.

public tcResultSet findUsersFiltered(Map phAttributeList, String[] pasFieldList) throws tcAPIException

Modified to allow single quotes in user IDs.

public tcResultSet findUsersFiltered(Map phAttributeList, String[] pasFieldList, int startRow, int pageSize, String[] order, boolean ascendingOrder) throws tcAPIException

Modified to allow single quotes in user IDs.

public tcDataSetData findUsers(tcMapping[] paoAttributeList, String permission, String[] status) throws tcAPIException

Modified to allow single quotes in user IDs.

public String[] getUserFromObjectInfo(String psObjName, String psColumnName, String psColumnValue) throws tcAPIException

Modified to allow single quotes in user IDs.

Table 2-13 lists the group operation APIs that were modified in Release 9.0.2.0.

Table 2-13 Modified Group Operation APIs in Release 9.0.2.0

API Changes

public long createGroup(Map phAttributes) throws tcAPIException, tcDuplicateGroupException, tcInvalidAttributeException

Modified to allow single quotes in group names.

public tcResultSet findGroups(Map phAttributeList, String permission) throws tcAPIException

Modified to allow single quotes in group names.

public tcResultSet findUnAssignedGroups(Map phAttributeList,long plUserKey) throws tcAPIException

Modified to allow single quotes in group names.

Table 2-14 lists the organization operation APIs that were modified in Release 9.0.2.0.

Table 2-14 Modified Organization Operation APIs in Release 9.0.2.0

API Changes

public long createOrganization(Map phMapping) throws tcDuplicateOrganizationException, tcAttributeMissingException, tcInvalidAttributeException, tcInvalidNameException, tcAPIException

Modified to allow single quotes in organization names.

Table 2-15 lists the reconciliation operation APIs that were modified in Release 9.0.2.0.

Table 2-15 Modified Reconciliation Operation APIs in Release 9.0.2.0

API Changes

public long createReconciliationEvent(String psObjectName, Map poData, boolean pbFinishEvent, String psDateFormat) throws tcAPIException, tcObjectNotFoundException

Modified to allow single quotes in the psObjectName parameter.

public Set provideDeletionDetectionData(String psObjectName, Map[] paoAccountDataList) throws tcAPIException, tcIDNotFoundException, tcMultipleMatchesFoundException

Modified to allow single quotes in the psObjectName parameter.

public boolean ignoreEventAttributeData(String psObjectName, Map poData, String psFieldName, Map[] paoAttributeDataList, String psDateFormat) throws tcAPIException, tcObjectNotFoundException

Modified to allow single quotes in the psObjectName parameter.

public boolean ignoreEvent(String psObjectName, Map poData) throws tcAPIException, tcObjectNotFoundException

Modified to allow single quotes in the psObjectName parameter.

public boolean ignoreEvent(String psObjectName, Map poData, String psDateFormat) throws tcAPIException, tcObjectNotFoundException

Modified to allow single quotes in the psObjectName parameter.

Table 2-16 lists the report operation APIs that were modified in Release 9.0.2.0.

Table 2-16 Modified Report Operation APIs in Release 9.0.2.0

API Changes

public tcResultSet getPagedReportData(ReportInput reportInput) throws tcAPIException

Modified to allow single quotes in parameters. The format of Date type parameters is now based on the value of the Reports.InternalDateFormat property.

Table 2-17 lists the audit operation APIs that were modified in Release 9.0.2.0.

Table 2-17 Modified Audit Operation APIs in Release 9.0.2.0

API Changes

public void reIssueAuditMessage(int audJmsKey) throws tcAPIException

Modified so the message is reissued by the user that generated it.

public void reIssueAuditMessageByIdentifier(String auditor, String identifier) throws tcAPIException

Modified so the message is reissued by the user that generated it.

Table 2-18 lists the attestation definition operation APIs that were modified in Release 9.0.2.0.

Table 2-18 Modified Attestation Definition Operation APIs in Release 9.0.2.0

API Changes

public tcResultSet findAttestationProcesses(Map attributes)

Modified to allow single quotes in parameters.

Modified APIs in Release 9.0.1.1

Table 2-19 lists the group operation APIs that were modified in Release 9.0.1.1.

Table 2-19 Modified Group Operation APIs in Release 9.0.1.1

Old API New API Changes

private tcDataSetData getAllMembersData(long plGroupKey) throws tcAPIException, tcGroupNotFoundException

public tcResultSet getAllMembers(long plGroupKey) throws tcGroupNotFoundException, tcAPIException

Modified to prevent users from being returned by indirect inclusion in subgroups.

public tcResultSet getMemberUsers(long plGroupKey)throws tcAPIException, tcGroupNotFoundException

Same as old API

Modified to prevent users from being returned by indirect inclusion in subgroups.

Table 2-20 lists the request operation APIs that were modified in Release 9.0.1.1.

Table 2-20 Modified Request Operation APIs in Release 9.0.1.1

API Changes

public int getNumberOfApprovalTasksAssignedToUser(long userKey, String[] statuses) throws tcUserNotFoundException, tcAPIException

Optimized for better performance with Oracle databases.

public tcResultSet getApprovalTasksAssignedToUser(long userKey, Map attributeList)throws tcUserNotFoundException, tcAPIException, tcAttributeNotFoundException

Optimized for better performance with Oracle databases.

public tcResultSet getApprovalTasksAssignedToManagedUsers(long userKey,Map attributeList)throws tcAPIException, tcUserNotFoundException, tcAttributeNotFoundException

Optimized for better performance with Oracle databases.

Table 2-21 lists the report operation APIs that were modified in Release 9.0.1.1.

Table 2-21 Modified Report Operation APIs in Release 9.0.1.1

API Changes

public tcResultSet getOperationalReports(long userKey) throws tcUserNotFoundException, tcAPIException

Modified to prevent the return of duplicate rows for users who belong to multiple groups with the same allowed reports.

public tcResultSet getHistoricalReports(long userKey) throws tcUserNotFoundException, tcAPIException

Modified to prevent the return of duplicate rows for users who belong to multiple groups with the same allowed reports.

public tcResultSet getPagedReportData(ReportInput reportInput)throws tcAPIException

Modified to retrieve the date format from system properties.

Table 2-22 lists the audit operation APIs that were modified in Release 9.0.1.1.

Table 2-22 Modified Audit Operation APIs in Release 9.0.1.1

API Changes

public void reIssueAuditMessage(int audJmsKey) throws tcAPIException

Modified to allow the reissuing of failed audit messages.

public void reIssueAuditMessageByIdentifier(String auditor, String identifier) throws tcAPIException

Modified to allow the reissuing of failed audit messages.

Table 2-23 lists the attestation definition operation APIs that were modified in Release 9.0.1.1.

Table 2-23 Modified Attestation Definition Operation APIs in Release 9.0.1.1

API Changes

public long createAttestationDefinition(AttestationProcessDefinition definition)throws DuplicateAttestationProcessException, tcAPIException

Enhanced to allow users to specify whether to include users in the sub organizations to be attested when the attestation scope is Organization Users

public void updateAttestationDefinition(long processDefKey, AttestationProcessDefinition definition) throws DuplicateAttestationProcessException, tcInvalidPermissionsException, tcAPIException, AttestationProcessNotFoundException

Enhanced to allow users to specify whether to include users in the sub organizations to be attested when the attestation scope is Organization Users

public AttestationProcessDefinition getAttestationProcessDefinition(long processDefKey) throws tcAPIException, AttestationProcessNotFoundException

Enhanced to allow users to specify whether to include users in the sub organizations to be attested when the attestation scope is Organization Users

Modified APIs in Release 9.0.1.0

Table 2-24 lists the user operation APIs that were modified in Release 9.0.1.0.


Note:

OIU_OFFLINED_DATE, sch_offlined and XL.OfflineApprovals are reserved for internal use only.

Table 2-24 Modified User Operation APIs in Release 9.0.1.0

API Comments 
private tcDataSetData getObjectsData(long plUserKey) 
throws tcAPIException, tcUserNotFoundException

Modified the API to return an extra column OIU_OFFLINED_DATE. If this column value is not null, then the provisioned instance is off-lined at the date returned in that column and message is not yet processed by the JMS message handler and the off-lined message is still in the JMS queue.

 
public long setProxyForUser(long userKey, 
long proxyUserKey, Date startDate, Date endDate) 
throws tcAPIException, tcUserNotFoundException, 
tcRecursiveProxyException

Enhanced the API to return error codes along with tcAPIException, if there are any errors in creating a proxy.

 
public void updateProxyForUser(long pxdKey, Map attribute) 
throws tcAPIException, tcUserNotFoundException, 
tcRecursiveProxyException

Enhanced the API to return error codes along with tcAPIException, if there are any errors in updating a proxy.

Table 2-25 lists the form instance operation APIs that were modified in Release 9.0.1.0.

Table 2-25 Modified Form Instance Operation APIs in Release 9.0.1.0

API Comments 
private void setProcessFormData(long plProcessInstanceKey, 
tcMapping[] phAttributeList) throws tcAPIException, 
tcInvalidValueException, tcNotAtomicProcessException, 
tcFormNotFoundException, tcRequiredDataMissingException, 
tcProcessNotFoundException

If a message submitted for provisioning process offline and message is still in queue, then calling process form save sets off-lined date value to null so that message handler ignores the message as saving form would have already started provisioning process instantiation.

Table 2-26 lists the provisioning operation APIs in this release that were modified in Release 9.0.1.0.

Table 2-26 Modified Provisioning Operation APIs in Release 9.0.1.0

API Comments 
private tcDataSetData getProcessDetailData(long plProcessInstanceKey) 
throws tcAPIException, tcNotAtomicProcessException

A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, a positive integer is returned indicating that the message is submitted but not yet processed by the JMS handler.

 
public void updateTask(long plTaskInstanceKey, Map phAttributeList) 
throws tcTaskNotFoundException, tcAPIException, 
tcAwaitingObjectDataCompletionException, 
tcAwaitingApprovalDataCompletionException

If the API is called to set the task status or a response code, then the API checks if the XL.OfflineApprovals property is true or not. If it is set to true, then the task status/response code setting is off-lined so that the perceived performance seen by a user is enhanced when acting on the task.

 
public tcResultSet getAssignedProvisioningTasks(long userKey, 
Map attributeList, String[] statuses) 
throws tcAPIException, tcUserNotFoundException, 
tcAttributeNotFoundException

A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, a positive integer is returned indicating that the message is submitted but not yet processed by the JMS handler.

 
public tcResultSet getProvisioningTasksAssignedToManagedUsers(
long userKey, Map attributeList, String[] statuses) 
throws tcAPIException, tcUserNotFoundException, 
tcAttributeNotFoundException

A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, then a positive integer is returned indicating that the message is submitted and is yet to be processed by the JMS handler.

Table 2-27 lists the reconciliation operation APIs that were modified in Release 9.0.1.0

Table 2-27 Modified Reconciliation Operation APIs in Release 9.0.1.0

API Comments 
public boolean ignoreEvent(String psObjName, Map poData) 
throws tcAPIException, tcObjectNotFoundException

Modified API so that the reconciliation attribute passed to the map need not be case-sensitive.

 
public Boolean ignoreEventAttributeData(String psObjName, 
Map poData,String psFieldName, Map[] paoAttributeDataList) 
throws tcAPIException, tcObjectNotFoundException

Modified API so that the reconciliation attribute passed to the map need not be case-sensitive.

 
public boolean ignoreEvent(String psObjName, 
Map poData, String psDateFormat) throws tcAPIException, 
tcObjectNotFoundException

Modified the API so that the reconciliation attribute passed to the map need not be case-sensitive.

 
public Boolean ignoreEventAttributeData(String psObjName, 
Map poData, String psFieldName, Map[] paoAttributeDataList, 
String psDateFormat) throws tcAPIException, tcObjectNotFoundException

Modified the API so that the reconciliation attribute passed to the map need not be case-sensitive.

 
public void linkEventToResourceInstanceForUser(
long plReconciliationEventKey, long objectInstanceForUserKey) 
throws tcAPIException, tcEventNotFoundException

Fixed an issue so that when reconciliation event is manually linked to a process by calling this API, process form data is updated.

Table 2-28 lists the request operation APIs in this release that were modified in Release 9.0.1.0.

Table 2-28 Modified Request Operation APIs in Release 9.0.1.0

API Comments 
public void setRequestResponse(long plRequestKey, 
long plUserKey, String psResponse) throws tcAPIException, 
tcInvalidResponseException, tcAwaitingObjectDataCompletionException, 
tcAwaitingApprovalDataCompletionException

API checks if the XL.OfflineApprovals property is true. If it is set to true, the task is off-lined so that the perceived performance seen by a user is enhanced when acting on tasks.

 
public void setResourceResponse(long plUserKey, 
long plObjectInstanceKey, String psResponse) 
throws tcAPIException, tcInvalidResponseException

API checks if the XL.OfflineApprovals property is true or not. If it is set to true, the task is off-lined so that the perceived performance seen by a user is enhanced when acting on tasks.

 
public tcResultSet getApprovalTasksAssignedToUser(
long userKey, Map attributeList) throws tcUserNotFoundException, 
tcAPIException, tcAttributeNotFoundException

A new column value, sch_offlined, is returned along with all other task information. If the task approval is off-lined and a JMS message is in queue for this task, a positive integer is returned indicating that the message is submitted but not yet processed by the JMS handler.

 
public tcResultSet getApprovalTasksAssigned(
Map attributeList) throws tcUserNotFoundException, 
tcAPIException, tcAttributeNotFoundException

A new column value, sch_offlined, is returned along with other task information. If the task approval is off-lined and a JMS message is in queue for this task, a positive integer is returned indicating that the message is submitted but not yet processed by the JMS handler.

 
public tcResultSet getApprovalTasksAssignedToManagedUsers(
long userKey, Map attributeList) throws tcAPIException, 
tcUserNotFoundException, tcAttributeNotFoundException

A new column value, sch_offlined, is returned along with other task information. If the task approval is off-lined and a JMS message is in the queue for this task, a positive integer is returned indicating that the message is submitted but not yet processed by the JMS handler.

 
public tcResultSet getProvisioningDetail(
long requestID) throws tcAPIException

Modified the API to return an extra column OIU_OFFLINED_DATE. If this column value is not null, it indicates that the provisioned instance is off-lined at the date returned in that column. It is not yet processed by the JMS message handler. The off-lined message is still in the JMS queue.

Table 2-29 lists the workflow operation APIs in this release that were modified in Release 9.0.1.0.

Table 2-29 Modified Workflow Operation APIs in Release 9.0.1.0

API Comments 
public WorkflowDefinition getWorkflowDefinition(
long workflowDefKey) throws tcAPIException

The API was modified so that task assignment rules are returned correctly.

Table 2-30 lists the report operation APIs in this release that were modified in Release 9.0.1.0.

Table 2-30 Modified Report Operation APIs in Release 9.0.1.0

API Comments 
public tcResultSet getPagedReportData(
ReportInput reportInput) throws tcAPIException

Added support to handle special input characters. If special characters are provided, a tcAPIException is thrown. Characters that are not allowed as input are: ; # / % = | + , \ " < >

Table 2-31 lists the audit operation APIs in this release that were modified in Release 9.0.1.0.

Table 2-31 Modified Audit Operation APIs in Release 9.0.1.0

API Comment 
public tcResultSet getUserProfile(long upa) 
throws tcAPIException

Modified the API so that it does not return a user updated date.

Go to previous page
Previous		 Go to next page
Next
Go to Documentation Home
Home		 Go to Table of Contents
Contents