REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete Local DB Index

post

/rest/v1/admin

Add, Search, Compare or Delete Local DB Index

Request

Supported Media Types

application/json

Local DB Index that needs to be created

Root Schema : Local DB Index POSTRequest

Type: object

Show Source

assertion: 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: object Local DB Index Properties
base: 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: array controls

LDAP controls to be sent to server for the LDAP operation.
dn: 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: 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(required): 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: 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: 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/Local DB Index 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 : Local DB Index Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-attribute: string

Read Only: true

Specifies the name of the attribute for which the index is to be maintained.
ds-cfg-index-entry-limit: 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: array ds-cfg-index-extensible-matching-rule

The extensible matching rule in an extensible index.
ds-cfg-index-type(required): array ds-cfg-index-type

Specifies the type(s) of indexing that should be performed for the associated attribute.
ds-cfg-purging: boolean

Default Value: false

Indicates whether this index older values should be purged.
ds-cfg-substring-length: integer(int32)

Default Value: 6

The length of substrings in a substring index.
ds-cfg-tombstones-included: boolean

Default Value: false

Indicates whether this index is maintained for tombstone entries as well.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":"6",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

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-index-extensible-matching-rule

Type: array

The extensible matching rule in an extensible index.

Show Source

Array of: string

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-index-type

Type: array

Specifies the type(s) of indexing that should be performed for the associated attribute.

Allowed Values:

[
    "approximate",
    "equality",
    "extensible",
    "ordering",
    "presence",
    "substring"
]

Show Source

Array of: string

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

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 : Local DB Index SuccessResponse

Type: object

Show Source

compareResult: boolean

Indicates the result of LDAP compare operation.
msgType(required): 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(required): array searchResultEntries

Number of search result entries returned after the LDAP operation.
totalResults(required): 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/Local DB Index 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 Local DB Index SearchResultEntry

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

Nested Schema : Local DB Index SearchResultEntry

Type: object

Show Source

attributes(required): object Local DB Index Properties
dn(required): 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/Local DB Index Properties"
        }
    }
}

Nested Schema : Local DB Index Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-attribute: string

Read Only: true

Specifies the name of the attribute for which the index is to be maintained.
ds-cfg-index-entry-limit: 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: array ds-cfg-index-extensible-matching-rule

The extensible matching rule in an extensible index.
ds-cfg-index-type(required): array ds-cfg-index-type

Specifies the type(s) of indexing that should be performed for the associated attribute.
ds-cfg-purging: boolean

Default Value: false

Indicates whether this index older values should be purged.
ds-cfg-substring-length: integer(int32)

Default Value: 6

The length of substrings in a substring index.
ds-cfg-tombstones-included: boolean

Default Value: false

Indicates whether this index is maintained for tombstone entries as well.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":"6",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-index-extensible-matching-rule

Type: array

The extensible matching rule in an extensible index.

Show Source

Array of: string

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-index-type

Type: array

Specifies the type(s) of indexing that should be performed for the associated attribute.

Allowed Values:

[
    "approximate",
    "equality",
    "extensible",
    "ordering",
    "presence",
    "substring"
]

Show Source

Array of: string

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

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 : Local DB Index ADDResponse

Type: object

Show Source

msgType(required): string

Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

The REST message type
searchResultEntries(required): array searchResultEntries
totalResults(required): 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/Local DB Index SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object Local DB Index SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Local DB Index SearchResultEntry"
    }
}

Nested Schema : Local DB Index SearchResultEntry

Type: object

Show Source

attributes(required): object Local DB Index Properties
dn(required): 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/Local DB Index Properties"
        }
    }
}

Nested Schema : Local DB Index Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-attribute: string

Read Only: true

Specifies the name of the attribute for which the index is to be maintained.
ds-cfg-index-entry-limit: 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: array ds-cfg-index-extensible-matching-rule

The extensible matching rule in an extensible index.
ds-cfg-index-type(required): array ds-cfg-index-type

Specifies the type(s) of indexing that should be performed for the associated attribute.
ds-cfg-purging: boolean

Default Value: false

Indicates whether this index older values should be purged.
ds-cfg-substring-length: integer(int32)

Default Value: 6

The length of substrings in a substring index.
ds-cfg-tombstones-included: boolean

Default Value: false

Indicates whether this index is maintained for tombstone entries as well.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-index-type"
    ],
    "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-index-entry-limit":{
            "description":"Specifies the maximum number of entries that are allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-extensible-matching-rule":{
            "description":"The extensible matching rule in an extensible index. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute":{
            "description":"Specifies the name of the attribute for which the index is to be maintained. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-substring-length":{
            "description":"The length of substrings in a substring index. ",
            "readOnly":false,
            "default":"6",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-index-type":{
            "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "approximate",
                "equality",
                "extensible",
                "ordering",
                "presence",
                "substring"
            ]
        },
        "ds-cfg-tombstones-included":{
            "description":"Indicates whether this index is maintained for tombstone entries as well. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-purging":{
            "description":"Indicates whether this index older values should be purged. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-index-extensible-matching-rule

Type: array

The extensible matching rule in an extensible index.

Show Source

Array of: string

{
    "description":"The extensible matching rule in an extensible index. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-index-type

Type: array

Specifies the type(s) of indexing that should be performed for the associated attribute.

Allowed Values:

[
    "approximate",
    "equality",
    "extensible",
    "ordering",
    "presence",
    "substring"
]

Show Source

Array of: string

{
    "description":"Specifies the type(s) of indexing that should be performed for the associated attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "approximate",
        "equality",
        "extensible",
        "ordering",
        "presence",
        "substring"
    ]
}

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: integer(int32)

Specifies the LDAP error code returned for the operation.
message(required): string

Error message returned returned for the operation.
msgType(required): 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."
        }
    }
}