REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete FIFO Entry Cache

post

/rest/v1/admin

Add, Search, Compare or Delete FIFO Entry Cache

Request

Supported Media Types

application/json

FIFO Entry Cache that needs to be created

Root Schema : FIFO Entry Cache POSTRequest

Type: object

Show Source

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 FIFO Entry Cache 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.


{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "dn":{
            "description":"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.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/FIFO Entry Cache Properties"
        },
        "base":{
            "description":"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",
            "type":"string"
        },
        "scope":{
            "description":"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.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"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.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"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.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"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.",
            "type":"string"
        }
    }
}

Nested Schema : FIFO Entry Cache Properties

Type: object

Show Source

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 entries that should be excluded from the cache.
ds-cfg-include-filter(optional): array ds-cfg-include-filter

The set of filters that define the entries that should be included in the cache.
ds-cfg-java-class: string

Default Value: org.opends.server.extensions.FIFOEntryCache

Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation.
ds-cfg-lock-timeout(optional): string

Default Value: 2000.0ms

Specifies the length of time to wait while attempting to acquire a read or write lock.
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: 90

Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-cache-level",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FIFOEntryCache",
            "type":"string"
        },
        "ds-cfg-max-memory-percent":{
            "description":"Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":90,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-exclude-filter":{
            "description":"The set of filters that define the entries that should be excluded from the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-entries":{
            "description":"Specifies the maximum number of entries that we will allow in the cache. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-include-filter":{
            "description":"The set of filters that define the entries that should be included in the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-level":{
            "description":"Specifies the cache level in the cache order if more than one instance of the cache is configured. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Entry Cache is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-lock-timeout":{
            "description":"Specifies the length of time to wait while attempting to acquire a read or write lock. ",
            "readOnly":false,
            "default":"2000.0ms",
            "type":"string"
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for the LDAP operation.

Show Source

Array of: string


{
    "description":"LDAP controls to be sent to server for the LDAP operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

Array of: string


{
    "description":"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.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-exclude-filter

Type: array

The set of filters that define the entries that should be excluded from the cache.

Show Source

Array of: string


{
    "description":"The set of filters that define the entries that should be excluded from the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-include-filter

Type: array

The set of filters that define the entries that should be included in the cache.

Show Source

Array of: string


{
    "description":"The set of filters that define the entries that should be included in the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string


{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : FIFO Entry Cache SuccessResponse

Type: object

Show Source

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.


{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/FIFO Entry Cache SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object FIFO Entry Cache SearchResultEntry


{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/FIFO Entry Cache SearchResultEntry"
    }
}

Nested Schema : FIFO Entry Cache SearchResultEntry

Type: object

Show Source

attributes: object FIFO Entry Cache Properties
dn: string

LDAP DN of the entry to be created


{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/FIFO Entry Cache Properties"
        }
    }
}

Nested Schema : FIFO Entry Cache Properties

Type: object

Show Source

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 entries that should be excluded from the cache.
ds-cfg-include-filter(optional): array ds-cfg-include-filter

The set of filters that define the entries that should be included in the cache.
ds-cfg-java-class: string

Default Value: org.opends.server.extensions.FIFOEntryCache

Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation.
ds-cfg-lock-timeout(optional): string

Default Value: 2000.0ms

Specifies the length of time to wait while attempting to acquire a read or write lock.
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: 90

Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-cache-level",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FIFOEntryCache",
            "type":"string"
        },
        "ds-cfg-max-memory-percent":{
            "description":"Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":90,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-exclude-filter":{
            "description":"The set of filters that define the entries that should be excluded from the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-entries":{
            "description":"Specifies the maximum number of entries that we will allow in the cache. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-include-filter":{
            "description":"The set of filters that define the entries that should be included in the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-level":{
            "description":"Specifies the cache level in the cache order if more than one instance of the cache is configured. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Entry Cache is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-lock-timeout":{
            "description":"Specifies the length of time to wait while attempting to acquire a read or write lock. ",
            "readOnly":false,
            "default":"2000.0ms",
            "type":"string"
        }
    }
}

Nested Schema : ds-cfg-exclude-filter

Type: array

The set of filters that define the entries that should be excluded from the cache.

Show Source

Array of: string


{
    "description":"The set of filters that define the entries that should be excluded from the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-include-filter

Type: array

The set of filters that define the entries that should be included in the cache.

Show Source

Array of: string


{
    "description":"The set of filters that define the entries that should be included in the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string


{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

201 Response

Created

Root Schema : FIFO Entry Cache ADDResponse

Type: object

Show Source

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.


{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FIFO Entry Cache SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object FIFO Entry Cache SearchResultEntry


{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FIFO Entry Cache SearchResultEntry"
    }
}

Nested Schema : FIFO Entry Cache SearchResultEntry

Type: object

Show Source

attributes: object FIFO Entry Cache Properties
dn: string

LDAP DN of the entry to be created


{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/FIFO Entry Cache Properties"
        }
    }
}

Nested Schema : FIFO Entry Cache Properties

Type: object

Show Source

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 entries that should be excluded from the cache.
ds-cfg-include-filter(optional): array ds-cfg-include-filter

The set of filters that define the entries that should be included in the cache.
ds-cfg-java-class: string

Default Value: org.opends.server.extensions.FIFOEntryCache

Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation.
ds-cfg-lock-timeout(optional): string

Default Value: 2000.0ms

Specifies the length of time to wait while attempting to acquire a read or write lock.
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: 90

Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.


{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-cache-level",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FIFOEntryCache",
            "type":"string"
        },
        "ds-cfg-max-memory-percent":{
            "description":"Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":90,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-exclude-filter":{
            "description":"The set of filters that define the entries that should be excluded from the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-entries":{
            "description":"Specifies the maximum number of entries that we will allow in the cache. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-include-filter":{
            "description":"The set of filters that define the entries that should be included in the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-level":{
            "description":"Specifies the cache level in the cache order if more than one instance of the cache is configured. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Entry Cache is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-lock-timeout":{
            "description":"Specifies the length of time to wait while attempting to acquire a read or write lock. ",
            "readOnly":false,
            "default":"2000.0ms",
            "type":"string"
        }
    }
}

Nested Schema : ds-cfg-exclude-filter

Type: array

The set of filters that define the entries that should be excluded from the cache.

Show Source

Array of: string


{
    "description":"The set of filters that define the entries that should be excluded from the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-include-filter

Type: array

The set of filters that define the entries that should be included in the cache.

Show Source

Array of: string


{
    "description":"The set of filters that define the entries that should be included in the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string


{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

204 Response

No content

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

Show Source

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


{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

Oracle Account

Oracle Account

Sign in to Cloud

REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete FIFO Entry Cache

Request

Response

200 Response

201 Response

204 Response

406 Response