Add, Search, Compare or Delete Add Inbound Attribute Transformation
/rest/v1/admin
Add, Search, Compare or Delete Add Inbound Attribute Transformation
Request
- application/json
object
-
assertion(optional):
string
Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
-
attributes(optional):
object Add Inbound Attribute Transformation Properties
-
base(optional):
string
Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
-
controls(optional):
array controls
LDAP controls to be sent to server for the LDAP operation.
-
dn(optional):
string
LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
-
filter(optional):
string
Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
-
msgType:
string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
The REST message type -
requiredAttributes(optional):
array requiredAttributes
List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
-
scope(optional):
string
Allowed Values:
[ "base", "sub", "one" ]
Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-conflict-behavior(optional):
string
Default Value:
merge-real-and-virtual
Allowed Values:[ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]
Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. Default is merge-real-and-virtual. -
ds-cfg-entry-match-filter(optional):
string
Specifies the filter that the entry must match for this transformation to apply.
-
ds-cfg-entry-parent-suffix(optional):
array ds-cfg-entry-parent-suffix
Specifies an antecedent of the operation DN for this transformation to apply.
-
ds-cfg-excluded-operation(optional):
array ds-cfg-excluded-operation
Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.
-
ds-cfg-java-class:
string
Default Value:
org.opends.server.core.transformations.attributetransformations.AddInboundAttribute
Specifies the fully-qualified name of the Java class that provides the Add Inbound Attribute Transformation implementation. -
ds-cfg-source-attribute:
string
Source attribute to be added and its values definitions.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
array
-
Array of:
string
array
-
Array of:
string
array
-
Array of:
string
array
[
"add",
"compare",
"delete",
"extended",
"modify",
"modifydn",
"search"
]
-
Array of:
string
array
-
Array of:
string
Response
- application/json
200 Response
object
-
compareResult(optional):
boolean
Indicates the result of LDAP compare operation.
-
msgType:
string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
The REST message type -
searchResultEntries:
array searchResultEntries
Number of search result entries returned after the LDAP operation.
-
totalResults:
integer(int32)
Specifies the number of entries created, and returned.
array
-
Array of:
object Add Inbound Attribute Transformation SearchResultEntry
object
-
attributes:
object Add Inbound Attribute Transformation Properties
-
dn:
string
LDAP DN of the entry to be created
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-conflict-behavior(optional):
string
Default Value:
merge-real-and-virtual
Allowed Values:[ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]
Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. Default is merge-real-and-virtual. -
ds-cfg-entry-match-filter(optional):
string
Specifies the filter that the entry must match for this transformation to apply.
-
ds-cfg-entry-parent-suffix(optional):
array ds-cfg-entry-parent-suffix
Specifies an antecedent of the operation DN for this transformation to apply.
-
ds-cfg-excluded-operation(optional):
array ds-cfg-excluded-operation
Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.
-
ds-cfg-java-class:
string
Default Value:
org.opends.server.core.transformations.attributetransformations.AddInboundAttribute
Specifies the fully-qualified name of the Java class that provides the Add Inbound Attribute Transformation implementation. -
ds-cfg-source-attribute:
string
Source attribute to be added and its values definitions.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
array
-
Array of:
string
array
[
"add",
"compare",
"delete",
"extended",
"modify",
"modifydn",
"search"
]
-
Array of:
string
array
-
Array of:
string
201 Response
object
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
The REST message type -
searchResultEntries:
array searchResultEntries
-
totalResults:
integer(int32)
Specifies the number of entries created, and returned.
array
-
Array of:
object Add Inbound Attribute Transformation SearchResultEntry
object
-
attributes:
object Add Inbound Attribute Transformation Properties
-
dn:
string
LDAP DN of the entry to be created
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-conflict-behavior(optional):
string
Default Value:
merge-real-and-virtual
Allowed Values:[ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]
Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. Default is merge-real-and-virtual. -
ds-cfg-entry-match-filter(optional):
string
Specifies the filter that the entry must match for this transformation to apply.
-
ds-cfg-entry-parent-suffix(optional):
array ds-cfg-entry-parent-suffix
Specifies an antecedent of the operation DN for this transformation to apply.
-
ds-cfg-excluded-operation(optional):
array ds-cfg-excluded-operation
Specifies operations on which this transformation never apply. This allows to restrict the regular behavior of this transformation.
-
ds-cfg-java-class:
string
Default Value:
org.opends.server.core.transformations.attributetransformations.AddInboundAttribute
Specifies the fully-qualified name of the Java class that provides the Add Inbound Attribute Transformation implementation. -
ds-cfg-source-attribute:
string
Source attribute to be added and its values definitions.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
array
-
Array of:
string
array
[
"add",
"compare",
"delete",
"extended",
"modify",
"modifydn",
"search"
]
-
Array of:
string
array
-
Array of:
string
204 Response
406 Response
object
-
ldapErrorCode(optional):
integer(int32)
Specifies the LDAP error code returned for the operation.
-
message:
string
Error message returned returned for the operation.
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
The REST message type