Jump to

• Request
• Response

Find FIFO Group Entry Cache by DN

get

/rest/v1/admin/{dn}

Returns an FIFO Group Entry Cache by DN

Request

Supported Media Types

• application/json

Path Parameters

• dn: string
  LDAP DN of the entry to be fetched.

Query Parameters

• attributes: array
  Collection Format: multi

  List of attributes to be fetched for the entry.

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  Collection Format: multi

  LDAP controls to be sent to server for search operation.

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
• scope: string
  Scope for the LDAP search operation.

  Allowed Values: [ "base", "sub", "one" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : FIFO Group Entry Cache GetSuccessResponse

Type: object

Show Source

• msgType: string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  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",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "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 Group Entry Cache SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• [0]: object FIFO Group Entry Cache SearchResultEntry

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

Nested Schema : FIFO Group Entry Cache SearchResultEntry

Type: object

Show Source

• attributes: object FIFO Group 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 Group Entry Cache Properties"
        }
    }
}

Nested Schema : FIFO Group 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 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.

{
    "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 Group Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FIFOGroupCache",
            "type":"string"
        },
        "ds-cfg-max-memory-percent":{
            "description":"Specifies the maximum memory usage for the group entry cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":5,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-exclude-filter":{
            "description":"The set of filters that define the groups that should be excluded from the cache. ",
            "readOnly":false,
            "default":[
                "(objectClass=ds-virtual-static-group)"
            ],
            "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 groups that should be included in the cache. ",
            "readOnly":false,
            "default":[
                "(|(objectClass=groupOfNames)(objectClass=groupOfUniqueNames)(objectClass=groupOfEntries))"
            ],
            "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"
        }
    }
}

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: [ "(objectClass=ds-virtual-static-group)" ]

Show Source

• [0]: string

{
    "description":"The set of filters that define the groups that should be excluded from the cache. ",
    "readOnly":false,
    "default":[
        "(objectClass=ds-virtual-static-group)"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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: [ "(|(objectClass=groupOfNames)(objectClass=groupOfUniqueNames)(objectClass=groupOfEntries))" ]

Show Source

• [0]: string

{
    "description":"The set of filters that define the groups that should be included in the cache. ",
    "readOnly":false,
    "default":[
        "(|(objectClass=groupOfNames)(objectClass=groupOfUniqueNames)(objectClass=groupOfEntries))"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• [0]: string

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

406 Response

Not Acceptable

Body ()

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."
        }
    }
}

Back to Top