Modify a FIFO Group Entry Cache by DN
patch
/rest/v1/admin/{dn}
Modify a FIFO Group Entry Cache by DN
Request
Supported Media Types
- application/json
Path Parameters
-
dn: string
LDAP DN of the entry to be modified
FIFO Group Entry Cache that needs to be modified
Root Schema : PatchRequest
Type:
Show Source
object
-
controls(optional):
array controls
LDAP controls to be sent to server for LDAP modify operation.
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest
The REST message type -
operations:
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:
string
The entry attribute to be modified.
-
opType:
string
Allowed Values:
[ "add", "delete", "replace", "increment" ]
The type of the Patch Operation. -
values(optional):
array values
The attribute values to be updated.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : FIFO Group Entry Cache PatchSuccessResponse
Type:
Show Source
object
-
msgType:
string
Default Value:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse
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.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : FIFO Group Entry Cache SearchResultEntry
Type:
Show Source
object
-
attributes:
object FIFO Group Entry Cache Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : FIFO Group Entry Cache Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-cache-level:
integer(int32)
Specifies the cache level in the cache order if more than one instance of the cache is configured.
-
ds-cfg-enabled:
boolean
Indicates whether the Entry Cache is enabled.
-
ds-cfg-exclude-filter(optional):
array ds-cfg-exclude-filter
The set of filters that define the groups that should be excluded from the cache.
-
ds-cfg-include-filter(optional):
array ds-cfg-include-filter
The set of filters that define the groups that should be included in the cache.
-
ds-cfg-java-class:
string
Default Value:
org.opends.server.extensions.FIFOGroupCache
Specifies the fully-qualified name of the Java class that provides the FIFO Group Entry Cache implementation. -
ds-cfg-max-entries(optional):
integer(int32)
Default Value:
2147483647
Specifies the maximum number of entries that we will allow in the cache. -
ds-cfg-max-memory-percent(optional):
integer(int32)
Default Value:
5
Specifies the maximum memory usage for the group entry cache as a percentage of the total JVM memory. -
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-exclude-filter
Type:
array
The set of filters that define the groups that should be excluded from the cache.
Default Value:
Show Source
[
"(objectClass=ds-virtual-static-group)"
]
Nested Schema : ds-cfg-include-filter
Type:
array
The set of filters that define the groups that should be included in the cache.
Default Value:
Show Source
[
"(|(objectClass=groupOfNames)(objectClass=groupOfUniqueNames)(objectClass=groupOfEntries))"
]
400 Response
ERROR
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
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