REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete Request Filtering QOS Policy

post

/rest/v1/admin

Add, Search, Compare or Delete Request Filtering QOS Policy

Request

Supported Media Types

application/json

Request Filtering QOS Policy that needs to be created

Root Schema : Request Filtering QOS Policy 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 Request Filtering QOS Policy 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/Request Filtering QOS Policy 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 : Request Filtering QOS Policy Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-allowed-attributes(optional): array ds-cfg-allowed-attributes

Specifies which attributes are allowed in search and compare operations.
ds-cfg-allowed-operations(optional): array ds-cfg-allowed-operations

Specifies which operations are allowed by the server.
ds-cfg-allowed-search-scopes(optional): array ds-cfg-allowed-search-scopes

Specifies which search scopes are allowed by the server.
ds-cfg-allowed-subtrees(optional): array ds-cfg-allowed-subtrees

Specifies which subtrees are accessible to clients.
ds-cfg-java-class: string

Default Value: org.opends.server.core.networkgroups.RequestFilteringPolicyFactory

Specifies the fully-qualified name of the Java class that provides the Request Filtering QOS Policy implementation.
ds-cfg-prohibited-attributes(optional): array ds-cfg-prohibited-attributes

Specifies which attributes are not allowed in search and compare operations.
ds-cfg-prohibited-subtrees(optional): array ds-cfg-prohibited-subtrees

Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class"
    ],
    "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 Request Filtering QOS Policy implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.networkgroups.RequestFilteringPolicyFactory",
            "type":"string"
        },
        "ds-cfg-allowed-attributes":{
            "description":"Specifies which attributes are allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-search-scopes":{
            "description":"Specifies which search scopes are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "base",
                "children",
                "one",
                "sub"
            ]
        },
        "ds-cfg-prohibited-subtrees":{
            "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-subtrees":{
            "description":"Specifies which subtrees are accessible to clients. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-operations":{
            "description":"Specifies which operations are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "inequality-search",
                "modify",
                "rename",
                "search"
            ]
        },
        "ds-cfg-prohibited-attributes":{
            "description":"Specifies which attributes are not allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "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-allowed-attributes

Type: array

Specifies which attributes are allowed in search and compare operations.

Show Source

Array of: string

{
    "description":"Specifies which attributes are allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-operations

Type: array

Specifies which operations are allowed by the server.

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "extended",
    "inequality-search",
    "modify",
    "rename",
    "search"
]

Show Source

Array of: string

{
    "description":"Specifies which operations are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "inequality-search",
        "modify",
        "rename",
        "search"
    ]
}

Nested Schema : ds-cfg-allowed-search-scopes

Type: array

Specifies which search scopes are allowed by the server.

Allowed Values:

[
    "base",
    "children",
    "one",
    "sub"
]

Show Source

Array of: string

{
    "description":"Specifies which search scopes are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "base",
        "children",
        "one",
        "sub"
    ]
}

Nested Schema : ds-cfg-allowed-subtrees

Type: array

Specifies which subtrees are accessible to clients.

Show Source

Array of: string

{
    "description":"Specifies which subtrees are accessible to clients. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-prohibited-attributes

Type: array

Specifies which attributes are not allowed in search and compare operations.

Show Source

Array of: string

{
    "description":"Specifies which attributes are not allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-prohibited-subtrees

Type: array

Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree.

Show Source

Array of: string

{
    "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
    "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 : Request Filtering QOS Policy 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/Request Filtering QOS Policy 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 Request Filtering QOS Policy SearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Request Filtering QOS Policy SearchResultEntry"
    }
}

Nested Schema : Request Filtering QOS Policy SearchResultEntry

Type: object

Show Source

attributes: object Request Filtering QOS Policy 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/Request Filtering QOS Policy Properties"
        }
    }
}

Nested Schema : Request Filtering QOS Policy Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-allowed-attributes(optional): array ds-cfg-allowed-attributes

Specifies which attributes are allowed in search and compare operations.
ds-cfg-allowed-operations(optional): array ds-cfg-allowed-operations

Specifies which operations are allowed by the server.
ds-cfg-allowed-search-scopes(optional): array ds-cfg-allowed-search-scopes

Specifies which search scopes are allowed by the server.
ds-cfg-allowed-subtrees(optional): array ds-cfg-allowed-subtrees

Specifies which subtrees are accessible to clients.
ds-cfg-java-class: string

Default Value: org.opends.server.core.networkgroups.RequestFilteringPolicyFactory

Specifies the fully-qualified name of the Java class that provides the Request Filtering QOS Policy implementation.
ds-cfg-prohibited-attributes(optional): array ds-cfg-prohibited-attributes

Specifies which attributes are not allowed in search and compare operations.
ds-cfg-prohibited-subtrees(optional): array ds-cfg-prohibited-subtrees

Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class"
    ],
    "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 Request Filtering QOS Policy implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.networkgroups.RequestFilteringPolicyFactory",
            "type":"string"
        },
        "ds-cfg-allowed-attributes":{
            "description":"Specifies which attributes are allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-search-scopes":{
            "description":"Specifies which search scopes are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "base",
                "children",
                "one",
                "sub"
            ]
        },
        "ds-cfg-prohibited-subtrees":{
            "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-subtrees":{
            "description":"Specifies which subtrees are accessible to clients. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-operations":{
            "description":"Specifies which operations are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "inequality-search",
                "modify",
                "rename",
                "search"
            ]
        },
        "ds-cfg-prohibited-attributes":{
            "description":"Specifies which attributes are not allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-allowed-attributes

Type: array

Specifies which attributes are allowed in search and compare operations.

Show Source

Array of: string

{
    "description":"Specifies which attributes are allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-operations

Type: array

Specifies which operations are allowed by the server.

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "extended",
    "inequality-search",
    "modify",
    "rename",
    "search"
]

Show Source

Array of: string

{
    "description":"Specifies which operations are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "inequality-search",
        "modify",
        "rename",
        "search"
    ]
}

Nested Schema : ds-cfg-allowed-search-scopes

Type: array

Specifies which search scopes are allowed by the server.

Allowed Values:

[
    "base",
    "children",
    "one",
    "sub"
]

Show Source

Array of: string

{
    "description":"Specifies which search scopes are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "base",
        "children",
        "one",
        "sub"
    ]
}

Nested Schema : ds-cfg-allowed-subtrees

Type: array

Specifies which subtrees are accessible to clients.

Show Source

Array of: string

{
    "description":"Specifies which subtrees are accessible to clients. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-prohibited-attributes

Type: array

Specifies which attributes are not allowed in search and compare operations.

Show Source

Array of: string

{
    "description":"Specifies which attributes are not allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-prohibited-subtrees

Type: array

Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree.

Show Source

Array of: string

{
    "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
    "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 : Request Filtering QOS Policy 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/Request Filtering QOS Policy SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object Request Filtering QOS Policy SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Request Filtering QOS Policy SearchResultEntry"
    }
}

Nested Schema : Request Filtering QOS Policy SearchResultEntry

Type: object

Show Source

attributes: object Request Filtering QOS Policy 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/Request Filtering QOS Policy Properties"
        }
    }
}

Nested Schema : Request Filtering QOS Policy Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-allowed-attributes(optional): array ds-cfg-allowed-attributes

Specifies which attributes are allowed in search and compare operations.
ds-cfg-allowed-operations(optional): array ds-cfg-allowed-operations

Specifies which operations are allowed by the server.
ds-cfg-allowed-search-scopes(optional): array ds-cfg-allowed-search-scopes

Specifies which search scopes are allowed by the server.
ds-cfg-allowed-subtrees(optional): array ds-cfg-allowed-subtrees

Specifies which subtrees are accessible to clients.
ds-cfg-java-class: string

Default Value: org.opends.server.core.networkgroups.RequestFilteringPolicyFactory

Specifies the fully-qualified name of the Java class that provides the Request Filtering QOS Policy implementation.
ds-cfg-prohibited-attributes(optional): array ds-cfg-prohibited-attributes

Specifies which attributes are not allowed in search and compare operations.
ds-cfg-prohibited-subtrees(optional): array ds-cfg-prohibited-subtrees

Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree.
objectclass: array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class"
    ],
    "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 Request Filtering QOS Policy implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.networkgroups.RequestFilteringPolicyFactory",
            "type":"string"
        },
        "ds-cfg-allowed-attributes":{
            "description":"Specifies which attributes are allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-search-scopes":{
            "description":"Specifies which search scopes are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "base",
                "children",
                "one",
                "sub"
            ]
        },
        "ds-cfg-prohibited-subtrees":{
            "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-subtrees":{
            "description":"Specifies which subtrees are accessible to clients. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-operations":{
            "description":"Specifies which operations are allowed by the server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "extended",
                "inequality-search",
                "modify",
                "rename",
                "search"
            ]
        },
        "ds-cfg-prohibited-attributes":{
            "description":"Specifies which attributes are not allowed in search and compare operations. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-allowed-attributes

Type: array

Specifies which attributes are allowed in search and compare operations.

Show Source

Array of: string

{
    "description":"Specifies which attributes are allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-allowed-operations

Type: array

Specifies which operations are allowed by the server.

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "extended",
    "inequality-search",
    "modify",
    "rename",
    "search"
]

Show Source

Array of: string

{
    "description":"Specifies which operations are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "extended",
        "inequality-search",
        "modify",
        "rename",
        "search"
    ]
}

Nested Schema : ds-cfg-allowed-search-scopes

Type: array

Specifies which search scopes are allowed by the server.

Allowed Values:

[
    "base",
    "children",
    "one",
    "sub"
]

Show Source

Array of: string

{
    "description":"Specifies which search scopes are allowed by the server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "base",
        "children",
        "one",
        "sub"
    ]
}

Nested Schema : ds-cfg-allowed-subtrees

Type: array

Specifies which subtrees are accessible to clients.

Show Source

Array of: string

{
    "description":"Specifies which subtrees are accessible to clients. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-prohibited-attributes

Type: array

Specifies which attributes are not allowed in search and compare operations.

Show Source

Array of: string

{
    "description":"Specifies which attributes are not allowed in search and compare operations. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-prohibited-subtrees

Type: array

Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree.

Show Source

Array of: string

{
    "description":"Specifies which subtrees must be hidden from clients. Each prohibited subtree must be subordinate to an allowed subtree. ",
    "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."
        }
    }
}