Modify a Referential Integrity Plugin by DN
patch
/rest/v1/admin/{dn}
Modify a Referential Integrity Plugin by DN
Request
Supported Media Types
- application/json
Path Parameters
-
dn(required): string
LDAP DN of the entry to be modified
Referential Integrity Plugin that needs to be modified
Root Schema : PatchRequest
Type:
Show Source
object
-
controls:
array controls
LDAP controls to be sent to server for LDAP modify operation.
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest
The REST message type -
operations(required):
array operations
Modifications (Patch operations) to be performed on the entry.
Nested Schema : controls
Type:
array
LDAP controls to be sent to server for LDAP modify operation.
Show Source
Nested Schema : operations
Type:
array
Modifications (Patch operations) to be performed on the entry.
Show Source
Nested Schema : PatchOperation
Type:
Show Source
object
-
attribute(required):
string
The entry attribute to be modified.
-
opType(required):
string
Allowed Values:
[ "add", "delete", "replace", "increment" ]
The type of the Patch Operation. -
values:
array values
The attribute values to be updated.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Referential Integrity Plugin PatchSuccessResponse
Type:
Show Source
object
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse
The REST message type -
searchResultEntries(required):
array searchResultEntries
Number of search result entries returned after the LDAP operation.
-
totalResults(required):
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Referential Integrity Plugin SearchResultEntry
Type:
Show Source
object
-
attributes(required):
object Referential Integrity Plugin Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : Referential Integrity Plugin Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
ds-cfg-attribute-type(required):
array ds-cfg-attribute-type
Specifies the attribute types for which referential integrity is to be maintained.
-
ds-cfg-base-dn:
array ds-cfg-base-dn
Specifies the base DN that limits the scope within which referential integrity is maintained.
-
ds-cfg-enabled(required):
boolean
Indicates whether the plug-in is enabled for use.
-
ds-cfg-invoke-for-internal-operations:
boolean
Default Value:
true
Indicates whether the plug-in should be invoked for internal operations. -
ds-cfg-java-class(required):
string
Default Value:
org.opends.server.plugins.ReferentialIntegrityPlugin
Specifies the fully-qualified name of the Java class that provides the plug-in implementation. -
ds-cfg-log-file:
string
Default Value:
logs/referint
Specifies the log file location where the update records are written when the plug-in is in background-mode processing. -
ds-cfg-plugin-type(required):
array ds-cfg-plugin-type
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
-
ds-cfg-update-interval:
string
Default Value:
0 seconds
Specifies the interval in seconds when referential integrity updates are made. -
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-attribute-type
Type:
array
Specifies the attribute types for which referential integrity is to be maintained.
Show Source
Nested Schema : ds-cfg-base-dn
Type:
array
Specifies the base DN that limits the scope within which referential integrity is maintained.
Show Source
Nested Schema : ds-cfg-plugin-type
Type:
array
Specifies the set of plug-in types for the plug-in, which specifies the times at which the plug-in is invoked.
Default Value:
[
"postoperationdelete",
"postoperationmodifydn",
"subordinatemodifydn",
"subordinatedelete"
]
Allowed Values:
Show Source
[
"intermediateresponse",
"ldifexport",
"ldifimport",
"ldifimportbegin",
"ldifimportend",
"postconnect",
"postdisconnect",
"postoperationabandon",
"postoperationadd",
"postoperationbind",
"postoperationcompare",
"postoperationdelete",
"postoperationextended",
"postoperationmodify",
"postoperationmodifydn",
"postoperationsearch",
"postoperationunbind",
"postresponseadd",
"postresponsebind",
"postresponsecompare",
"postresponsedelete",
"postresponseextended",
"postresponsemodify",
"postresponsemodifydn",
"postresponsesearch",
"postsynchronizationadd",
"postsynchronizationdelete",
"postsynchronizationmodify",
"postsynchronizationmodifydn",
"preoperationadd",
"preoperationbind",
"preoperationcompare",
"preoperationdelete",
"preoperationextended",
"preoperationmodify",
"preoperationmodifydn",
"preoperationsearch",
"preparseabandon",
"preparseadd",
"preparsebind",
"preparsecompare",
"preparsedelete",
"preparseextended",
"preparsemodify",
"preparsemodifydn",
"preparsesearch",
"preparseunbind",
"searchresultentry",
"searchresultreference",
"shutdown",
"startup",
"subordinatedelete",
"subordinatemodifydn"
]
400 Response
ERROR
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
ldapErrorCode:
integer(int32)
Specifies the LDAP error code returned for the operation.
-
message(required):
string
Error message returned returned for the operation.
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
The REST message type