Find Global Index by DN
get
/rest/v1/admin/{dn}
Returns an Global Index by DN
Request
Supported Media Types
- application/json
Path Parameters
-
dn: string
LDAP DN of the entry to be fetched.
Query Parameters
- attributes: array
- controls: array
-
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" ]
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Global Index GetSuccessResponse
Type:
Show Source
object
-
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.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Global Index SearchResultEntry
Type:
Show Source
object
-
attributes:
object Global Index Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : Global Index Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-db-checkpointer-bytes-interval(optional):
string
Default Value:
20mb
Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint. -
ds-cfg-db-checkpointer-wakeup-interval(optional):
string
Default Value:
30s
Specifies the maximum length of time that may pass between checkpoints. -
ds-cfg-db-cleaner-min-utilization(optional):
integer(int32)
Default Value:
50
Specifies the minimum percentage of "live" data that the database cleaner attempts to keep in database log files. -
ds-cfg-db-directory:
string
Default Value:
catalogs
Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this Global Index. -
ds-cfg-db-directory-permissions(optional):
string
Default Value:
700
Specifies the permissions that should be applied to the directory containing the Global Index database files. -
ds-cfg-db-log-file-max(optional):
string
Default Value:
10mb
Specifies the maximum size for a database log file. -
ds-cfg-db-num-cleaner-threads(optional):
integer(int32)
Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization.
-
ds-cfg-db-num-lock-tables(optional):
integer(int32)
Specifies the number of lock tables that are used by the underlying database.
-
ds-cfg-db-txn-no-sync(optional):
boolean
Default Value:
false
Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk. -
ds-cfg-db-txn-write-no-sync(optional):
boolean
Default Value:
true
Indicates whether the database should synchronously flush data as it is written to disk. -
ds-cfg-deleted-entry-retention-timeout(optional):
string
Default Value:
500ms
Specifies how long a deleted entry is kept in the system. -
ds-cfg-global-index-attribute(optional):
string
Read Only:
true
Specifies the attribute to index. - ds-cfg-global-index-catalogs-shared-cache(optional): string
-
ds-cfg-je-property(optional):
array ds-cfg-je-property
Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.
-
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-je-property
Type:
array
Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.
Show Source
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