.NET API Reference for Oracle Identity Connector Framework 11.1.2
E41516-01
Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided.

Namespace: Org.IdentityConnectors.Framework.Api.Operations
Assembly: Framework (in Framework.dll) Version: 1.4.0.0 (1.4.0.0)

Syntax

C#
Uid RemoveAttributeValues(
	ObjectClass objclass,
	Uid uid,
	ICollection<ConnectorAttribute> valuesToRemove,
	OperationOptions options
)

Parameters

objclass
Type: Org.IdentityConnectors.Framework.Common.Objects..::..ObjectClass
the type of object to modify. Must not be null.
uid
Type: Org.IdentityConnectors.Framework.Common.Objects..::..Uid
the uid of the object to modify. Must not be null.
valuesToRemove
Type: System.Collections.Generic..::..ICollection<(Of <(<'ConnectorAttribute>)>)>
set of ConnectorAttribute deltas. The values for the attributes in this set represent the values to remove from attributes in the object. merged. This set must not include OperationalAttributes. Must not be null.
options
Type: Org.IdentityConnectors.Framework.Common.Objects..::..OperationOptions
additional options that impact the way this operation is run. May be null.

Return Value

Type: Uid
the Uid of the updated object in case the update changes the formation of the unique identifier.

Remarks

For each attribute that the input set contains, remove from the current values of that attribute in the target object any value that matches one of the values of the attribute from the input set.

NOTE that this does not specify how to handle unmatched values. The general assumption for an attribute of a

 Copy imageCopy
ConnectorObject
is that the values for an attribute are merely representational state. Therefore, the implementer should simply ignore any provided value that does not match a current value of that attribute in the target object. Deleting an unmatched value should always succeed.

IMPLEMENTATION NOTE: for connectors that merely implement UpdateOp and not UpdateAttributeValuesOp this method will be simulated by fetching, merging, and calling Update(ObjectClass, Uid, ICollection<(Of <<'(ConnectorAttribute>)>>), OperationOptions). Therefore, connector implementations are encourage to implement UpdateAttributeValuesOp from a performance and atomicity standpoint.

Exceptions

ExceptionCondition
Org.IdentityConnectors.Framework.Common.Exceptions..::..UnknownUidExceptioniff the Uid does not exist on the resource.

See Also