REST API for Oracle Unified Directory Administration

Modify a LDAP Connection Handler by DN

patch

/rest/v1/admin/{dn}

Modify a LDAP Connection Handler by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

LDAP Connection Handler that needs to be modified

Root Schema : PatchRequest

Type: object

Show Source

controls: array controls

LDAP controls to be sent to server for LDAP modify operation.
msgType(required): string

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

The REST message type
operations(required): array operations

Modifications (Patch operations) to be performed on the entry.

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : controls

Type: array

LDAP controls to be sent to server for LDAP modify operation.

Show Source

Array of: string

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : operations

Type: array

Modifications (Patch operations) to be performed on the entry.

Show Source

Array of: object PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

Nested Schema : PatchOperation

Type: object

Show Source

attribute(required): string

The entry attribute to be modified.
opType(required): string

Allowed Values: [ "add", "delete", "replace", "increment" ]

The type of the Patch Operation.
values: array values

The attribute values to be updated.

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : values

Type: array

The attribute values to be updated.

Show Source

Array of: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : LDAP Connection Handler PatchSuccessResponse

Type: object

Show Source

msgType(required): string

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

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",
            "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/LDAP Connection Handler SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object LDAP Connection Handler SearchResultEntry

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

Nested Schema : LDAP Connection Handler SearchResultEntry

Type: object

Show Source

attributes(required): object LDAP Connection Handler 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/LDAP Connection Handler Properties"
        }
    }
}

Nested Schema : LDAP Connection Handler Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-accept-backlog: 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-ldap-v2: boolean

Default Value: true

Indicates whether connections from LDAPv2 clients are allowed.
ds-cfg-allow-start-tls: boolean

Default Value: false

Indicates whether clients are allowed to use StartTLS.
ds-cfg-allow-tcp-reuse-address: boolean

Default Value: true

Indicates whether the LDAP Connection Handler should reuse socket descriptors.
ds-cfg-allowed-client: 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-buffer-size: string

Default Value: 4096 bytes

Specifies the size in bytes of the LDAP response message write buffer.
ds-cfg-denied-client: 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-enabled(required): boolean

Indicates whether the Connection Handler is enabled.
ds-cfg-java-class(required): string

Default Value: org.opends.server.protocols.ldap.LDAPConnectionHandler

Specifies the fully-qualified name of the Java class that provides the LDAP Connection Handler implementation.
ds-cfg-keep-stats: boolean

Default Value: true

Indicates whether the LDAP Connection Handler should keep statistics.
ds-cfg-key-manager-provider: string

Specifies the name of the key manager that should be used with this LDAP Connection Handler .
ds-cfg-listen-address: array ds-cfg-listen-address

Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients.
ds-cfg-listen-port(required): integer(int32)

Specifies the port number on which the LDAP Connection Handler will listen for connections from clients.
ds-cfg-max-blocked-write-time-limit: string

Default Value: 2 minutes

Specifies the maximum length of time that attempts to write data to LDAP clients should be allowed to block.
ds-cfg-max-request-size: string

Default Value: 5 megabytes

Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler.
ds-cfg-num-request-handlers: integer(int32)

Specifies the number of request handlers that are used to read requests from clients.
ds-cfg-send-rejection-notice: boolean

Default Value: true

Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason.
ds-cfg-ssl-cert-nickname: string

Specifies the nickname (also called the alias) of the certificate that the LDAP Connection Handler should use when performing SSL communication.
ds-cfg-ssl-cipher-suite: 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: string

Default Value: optional

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

Specifies the policy that the LDAP Connection Handler should use regarding client SSL certificates.
ds-cfg-ssl-protocol: 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: string

Specifies the name of the trust manager that should be used with the LDAP Connection Handler .
ds-cfg-use-ssl: boolean

Default Value: false

Indicates whether the LDAP Connection Handler should use SSL.
ds-cfg-use-tcp-keep-alive: boolean

Default Value: true

Indicates whether the LDAP Connection Handler should use TCP keep-alive.
ds-cfg-use-tcp-no-delay: boolean

Default Value: true

Indicates whether the LDAP Connection Handler should use TCP no-delay.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "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 LDAP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.ldap.LDAPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-keep-stats":{
            "description":"Indicates whether the LDAP Connection Handler should keep statistics. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-allow-ldap-v2":{
            "description":"Indicates whether connections from LDAPv2 clients are allowed. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-no-delay":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP no-delay. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "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-buffer-size":{
            "description":"Specifies the size in bytes of the LDAP response message write buffer. ",
            "readOnly":false,
            "default":"4096 bytes",
            "type":"string"
        },
        "ds-cfg-send-rejection-notice":{
            "description":"Indicates whether the LDAP Connection Handler should send a notice of disconnection extended response message to the client if a new connection is rejected for some reason. ",
            "readOnly":false,
            "default":true,
            "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 LDAP 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-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 LDAP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allow-tcp-reuse-address":{
            "description":"Indicates whether the LDAP Connection Handler should reuse socket descriptors. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the LDAP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the LDAP 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-max-blocked-write-time-limit":{
            "description":"Specifies the maximum length of time that attempts to write data to LDAP clients should be allowed to block. ",
            "readOnly":false,
            "default":"2 minutes",
            "type":"string"
        },
        "ds-cfg-max-request-size":{
            "description":"Specifies the size in bytes of the largest LDAP request message that will be allowed by this LDAP Connection handler. ",
            "readOnly":false,
            "default":"5 megabytes",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this LDAP Connection Handler should listen for connections from LDAP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-client-auth-policy":{
            "description":"Specifies the policy that the LDAP Connection Handler should use regarding client SSL certificates. ",
            "readOnly":false,
            "default":"optional",
            "type":"string",
            "enum":[
                "disabled",
                "optional",
                "required"
            ]
        },
        "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-allow-start-tls":{
            "description":"Indicates whether clients are allowed to use StartTLS. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-use-tcp-keep-alive":{
            "description":"Indicates whether the LDAP Connection Handler should use TCP keep-alive. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the LDAP Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-num-request-handlers":{
            "description":"Specifies the number of request handlers that are used to read requests from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ds-cfg-allowed-client

Type: array

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

Show Source

Array of: string

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

Nested Schema : ds-cfg-denied-client

Type: array

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

Show Source

Array of: string

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

Nested Schema : ds-cfg-listen-address

Type: array

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

Default Value:

[
    "0.0.0.0"
]

Show Source

Array of: string

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

Nested Schema : ds-cfg-ssl-cipher-suite

Type: array

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

Show Source

Array of: string

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

Nested Schema : ds-cfg-ssl-protocol

Type: array

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

Show Source

Array of: string

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

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"
    }
}

400 Response

ERROR

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