REST API for Oracle Unified Directory Administration

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

  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.

Copy{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "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/HTTP Connection Handler SearchResultEntry"
            }
        }
    }
}

• Array of: object HTTP Connection Handler SearchResultEntry

Copy{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/HTTP Connection Handler SearchResultEntry"
    }
}

• attributes: object HTTP Connection Handler Properties
• dn: string
  LDAP DN of the entry to be created

Copy{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/HTTP Connection Handler Properties"
        }
    }
}

• cn(optional): string
  CN (common name) of the entry
• ds-cfg-accept-backlog(optional): integer(int32)
  Default Value: 128

  Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts.
• ds-cfg-allow-tcp-reuse-address(optional): boolean
  Default Value: true

  Indicates whether the HTTP Connection Handler should reuse socket descriptors.
• ds-cfg-allowed-client(optional): array ds-cfg-allowed-client

  Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler.

• ds-cfg-denied-client(optional): array ds-cfg-denied-client

  Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler.

• ds-cfg-dos-filter-max-requests-per-sec(optional): integer(int32)
  Default Value: 25

  Specifies the maximum number of requests from a connection per second.
• ds-cfg-dos-filter-throttled-requests(optional): integer(int32)
  Default Value: 5

  Number of requests over the rate limit able to be considered at once.
• ds-cfg-enabled: boolean
  Indicates whether the Connection Handler is enabled.
• ds-cfg-header-cache-size(optional): string
  Default Value: 6 kilobytes

  Set the header field cache size.
• ds-cfg-http-server-max-thread-pool-size(optional): integer(int32)
  Default Value: 24

  Specifies the maximum number of threads to be used for processing operations placed in the queue by the embedded HTTP server.
• ds-cfg-http-server-max-work-queue-capacity(optional): integer(int32)
  Default Value: 6000

  Specifies the maximum number of queued operations that can be in the work queue at any given time.
• ds-cfg-http-server-min-thread-pool-size(optional): integer(int32)
  Default Value: 8

  Specifies the minimum number of threads to be used for processing operations placed in the queue by the embedded HTTP server.
• ds-cfg-idle-time-limit(optional): string
  Default Value: 60000 ms

  Set the maximum Idle time for a thread to be idle.
• ds-cfg-java-class: string
  Default Value: org.opends.server.protocols.http.HTTPConnectionHandler

  Specifies the fully-qualified name of the Java class that provides the HTTP Connection Handler implementation.
• ds-cfg-jetty-statistics-enabled(optional): boolean
  Default Value: false

  Indicates whether the HTTP Connection Handler should enable jetty statistics over JMX.
• ds-cfg-keep-stats(optional): boolean
  Default Value: true

  Indicates whether the HTTP Connection Handler should keep statistics.
• ds-cfg-key-manager-provider(optional): string
  Specifies the name of the key manager that should be used with this HTTP Connection Handler .
• ds-cfg-listen-address(optional): array ds-cfg-listen-address

  Specifies the address or set of addresses on which this HTTP Connection Handler should listen for connections from HTTP clients.

• ds-cfg-listen-port: integer(int32)
  Specifies the port number on which the HTTP Connection Handler will listen for connections from clients.
• ds-cfg-max-idle-time-limit(optional): string
  Default Value: 2 minutes

  Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call.
• ds-cfg-num-http-acceptor-threads(optional): integer(int32)
  Acceptors accept new TCP/IP connections
• ds-cfg-num-http-selector-threads(optional): integer(int32)
  Selectors notice and schedule established connection that can make IO progress.
• ds-cfg-output-buffer-size(optional): string
  Default Value: 32 kilobytes

  Sets the size of the content buffer for sending responses.
• ds-cfg-request-header-size(optional): string
  Default Value: 8 kilobytes

  Set the maximum size of a request header.
• ds-cfg-response-header-size(optional): string
  Default Value: 32 kilobytes

  Set the maximum size of a response header.
• ds-cfg-ssl-cert-nickname(optional): string
  Specifies the nickname (also called the alias) of the certificate that the HTTP Connection Handler should use when performing SSL communication.
• ds-cfg-ssl-cipher-suite(optional): array ds-cfg-ssl-cipher-suite

  Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication.

• ds-cfg-ssl-client-auth-policy(optional): string
  Default Value: optional

  Allowed Values: [ "disabled", "optional", "required" ]

  Specifies the policy that the HTTP Connection Handler should use regarding client SSL certificates.
• ds-cfg-ssl-protocol(optional): array ds-cfg-ssl-protocol

  Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication.

• ds-cfg-trust-manager-provider(optional): string
  Specifies the name of the trust manager that should be used with the HTTP Connection Handler .
• ds-cfg-use-ssl(optional): boolean
  Default Value: false

  Indicates whether the HTTP Connection Handler should use SSL.
• objectclass: array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-listen-port"
    ],
    "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 HTTP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.http.HTTPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-keep-stats":{
            "description":"Indicates whether the HTTP Connection Handler should keep statistics. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dos-filter-max-requests-per-sec":{
            "description":"Specifies the maximum number of requests from a connection per second. ",
            "readOnly":false,
            "default":25,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-jetty-statistics-enabled":{
            "description":"Indicates whether the HTTP Connection Handler should enable jetty statistics over JMX. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this HTTP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-accept-backlog":{
            "description":"Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts. ",
            "readOnly":false,
            "default":128,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-num-http-selector-threads":{
            "description":"Selectors notice and schedule established connection that can make IO progress. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-http-server-max-work-queue-capacity":{
            "description":"Specifies the maximum number of queued operations that can be in the work queue at any given time. ",
            "readOnly":false,
            "default":6000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the HTTP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allow-tcp-reuse-address":{
            "description":"Indicates whether the HTTP Connection Handler should reuse socket descriptors. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the HTTP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the HTTP Connection Handler should use SSL. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-http-server-max-thread-pool-size":{
            "description":"Specifies the maximum number of threads to be used for processing operations placed in the queue by the embedded HTTP server. ",
            "readOnly":false,
            "default":24,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this HTTP Connection Handler should listen for connections from HTTP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dos-filter-throttled-requests":{
            "description":"Number of requests over the rate limit able to be considered at once. ",
            "readOnly":false,
            "default":5,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-idle-time-limit":{
            "description":"Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call. ",
            "readOnly":false,
            "default":"2 minutes",
            "type":"string"
        },
        "ds-cfg-ssl-client-auth-policy":{
            "description":"Specifies the policy that the HTTP Connection Handler should use regarding client SSL certificates. ",
            "readOnly":false,
            "default":"optional",
            "type":"string",
            "enum":[
                "disabled",
                "optional",
                "required"
            ]
        },
        "ds-cfg-num-http-acceptor-threads":{
            "description":"Acceptors accept new TCP/IP connections ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-http-server-min-thread-pool-size":{
            "description":"Specifies the minimum number of threads to be used for processing operations placed in the queue by the embedded HTTP server. ",
            "readOnly":false,
            "default":8,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-request-header-size":{
            "description":"Set the maximum size of a request header. ",
            "readOnly":false,
            "default":"8 kilobytes",
            "type":"string"
        },
        "ds-cfg-output-buffer-size":{
            "description":"Sets the size of the content buffer for sending responses. ",
            "readOnly":false,
            "default":"32 kilobytes",
            "type":"string"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the HTTP Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-idle-time-limit":{
            "description":"Set the maximum Idle time for a thread to be idle. ",
            "readOnly":false,
            "default":"60000 ms",
            "type":"string"
        },
        "ds-cfg-header-cache-size":{
            "description":"Set the header field cache size. ",
            "readOnly":false,
            "default":"6 kilobytes",
            "type":"string"
        },
        "ds-cfg-response-header-size":{
            "description":"Set the maximum size of a response header. ",
            "readOnly":false,
            "default":"32 kilobytes",
            "type":"string"
        }
    }
}

• Array of: string

Copy{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the address or set of addresses on which this HTTP Connection Handler should listen for connections from HTTP clients. ",
    "readOnly":false,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

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

• 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

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