Find Local DB Index by DN
get
/rest/v1/admin/{dn}
Returns an Local DB 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 : Local DB 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 : Local DB Index SearchResultEntry
Type:
Show Source
object
-
attributes:
object Local DB Index Properties
-
dn:
string
LDAP DN of the entry to be created
Nested Schema : Local DB Index Properties
Type:
Show Source
object
-
cn(optional):
string
CN (common name) of the entry
-
ds-cfg-attribute(optional):
string
Read Only:
true
Specifies the name of the attribute for which the index is to be maintained. -
ds-cfg-index-entry-limit(optional):
integer(int32)
Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained.
-
ds-cfg-index-extensible-matching-rule(optional):
array ds-cfg-index-extensible-matching-rule
The extensible matching rule in an extensible index.
-
ds-cfg-index-type:
array ds-cfg-index-type
Specifies the type(s) of indexing that should be performed for the associated attribute.
-
ds-cfg-purging(optional):
boolean
Default Value:
false
Indicates whether this index older values should be purged. -
ds-cfg-substring-length(optional):
integer(int32)
Default Value:
6
The length of substrings in a substring index. -
ds-cfg-tombstones-included(optional):
boolean
Default Value:
false
Indicates whether this index is maintained for tombstone entries as well. -
objectclass:
array objectclass
Objectclass(es) which this entry belongs to.
Nested Schema : ds-cfg-index-extensible-matching-rule
Type:
array
The extensible matching rule in an extensible index.
Show Source
Nested Schema : ds-cfg-index-type
Type:
array
Specifies the type(s) of indexing that should be performed for the associated attribute.
Allowed Values:
Show Source
[
"approximate",
"equality",
"extensible",
"ordering",
"presence",
"substring"
]
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