Add, Search, Compare or Delete Last Mod Plugin
post
/rest/v1/admin
Add, Search, Compare or Delete Last Mod Plugin
Request
Supported Media Types
- application/json
Last Mod Plugin that needs to be created
Root Schema : Last Mod Plugin POSTRequest
Type:
Show Source
object
-
assertion:
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:
object Last Mod Plugin Properties
-
base:
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:
array controls
LDAP controls to be sent to server for the LDAP operation.
-
dn:
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:
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(required):
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:
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:
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.
Nested Schema : Last Mod Plugin Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
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.LastModPlugin
Specifies the fully-qualified name of the Java class that provides the plug-in implementation. -
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-use-authid-for-audit-attrs:
boolean
Default Value:
false
Specifies whether the server records the authentication ID, such as the bind DN, of the proxy acting on behalf of the user, or the authorization ID of the user for whom the proxy is requesting the operation. -
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : controls
Type:
array
LDAP controls to be sent to server for the LDAP operation.
Show Source
Nested Schema : requiredAttributes
Type:
array
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.
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:
[
"preoperationadd",
"preoperationmodify",
"preoperationmodifydn"
]
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"
]
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Last Mod Plugin SuccessResponse
Type:
Show Source
object
-
compareResult:
boolean
Indicates the result of LDAP compare operation.
-
msgType(required):
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(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 : Last Mod Plugin SearchResultEntry
Type:
Show Source
object
-
attributes(required):
object Last Mod Plugin Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : Last Mod Plugin Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
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.LastModPlugin
Specifies the fully-qualified name of the Java class that provides the plug-in implementation. -
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-use-authid-for-audit-attrs:
boolean
Default Value:
false
Specifies whether the server records the authentication ID, such as the bind DN, of the proxy acting on behalf of the user, or the authorization ID of the user for whom the proxy is requesting the operation. -
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
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:
[
"preoperationadd",
"preoperationmodify",
"preoperationmodifydn"
]
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"
]
201 Response
Created
Root Schema : Last Mod Plugin ADDResponse
Type:
Show Source
object
-
msgType(required):
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
The REST message type -
searchResultEntries(required):
array searchResultEntries
-
totalResults(required):
integer(int32)
Specifies the number of entries created, and returned.
Nested Schema : Last Mod Plugin SearchResultEntry
Type:
Show Source
object
-
attributes(required):
object Last Mod Plugin Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : Last Mod Plugin Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
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.LastModPlugin
Specifies the fully-qualified name of the Java class that provides the plug-in implementation. -
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-use-authid-for-audit-attrs:
boolean
Default Value:
false
Specifies whether the server records the authentication ID, such as the bind DN, of the proxy acting on behalf of the user, or the authorization ID of the user for whom the proxy is requesting the operation. -
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
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:
[
"preoperationadd",
"preoperationmodify",
"preoperationmodifydn"
]
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"
]
204 Response
No content
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