REST API for Oracle Unified Directory Administration

Modify a LDAP Server Extension by DN

patch

/rest/v1/admin/{dn}

Modify a LDAP Server Extension by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

LDAP Server Extension 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 Server Extension 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 Server Extension SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object LDAP Server Extension SearchResultEntry

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

Nested Schema : LDAP Server Extension SearchResultEntry

Type: object

Show Source

attributes(required): object LDAP Server Extension 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 Server Extension Properties"
        }
    }
}

Nested Schema : LDAP Server Extension Properties

Type: object

Show Source

cn: string

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

Default Value: oud

Allowed Values: [ "ad", "odsee", "oid", "oud" ]

Directory types used in ldap extension.
ds-cfg-enabled(required): boolean

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

Default Value: com.sun.dps.server.workflowelement.proxyldap.LDAPServerExtension

Specifies the fully-qualified name of the Java class that provides the LDAP Server Extension implementation.
ds-cfg-monitoring-check-interval: integer(int32)

Default Value: 30000

Proactive monitoring check interval.
ds-cfg-monitoring-connect-timeout: integer(int32)

Default Value: 5000

Maximum time the proactive monitoring attempts to connect to the remote server before the connections fails. 0 means unlimited.
ds-cfg-monitoring-inactivity-timeout: integer(int32)

Default Value: 120000

Time after which a connection is checked to avoid connection closure by the remote server. The value of this parameter must be superior to monitoring-check-interval.
ds-cfg-monitoring-ping-timeout: integer(int32)

Default Value: 5000

Maximum time the proactive monitoring attempts to ping the remote server.
ds-cfg-monitoring-statistics-interval: integer(int32)

Default Value: 30000

Proactive statistics collection interval.
ds-cfg-pool-increment: integer(int32)

Default Value: 5

Increment by which the size of a connection pool is increased or decreased. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the incremental change of size of each pool is set to pool-increment.
ds-cfg-pool-initial-size: integer(int32)

Default Value: 10

Initial size of a connection pool: this is the initial number of connections to be created when a pool is initialized. This is also the minimum size of a pool. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the initial size of each pool is set to pool-initial-size.
ds-cfg-pool-max-size: integer(int32)

Default Value: 1000

Maximum size of a connection pool: this is the maximum number of connections a pool can allocate. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the maximum size of each pool is set to pool-max-size.
ds-cfg-pool-max-write: integer(int32)

Default Value: 0

Maximum number of write connections a connection pool can allocate at the same time.
ds-cfg-pool-release-connection-interval: integer(int32)

Default Value: 300000

Time after which the connection pool size can be reduced if enough connections are not used: if pool-increment connections or more are not used during pool-release-connection-interval, then these connections are removed from the pool.
ds-cfg-pool-use-max-write: boolean

Default Value: false

Indicates if the parameter pool-max-write is used.
ds-cfg-proxied-auth-use-v1: boolean

Default Value: false

If true, proxy authorization control V1 is used, otherwise V2 is used.
ds-cfg-remote-ldap-server-address(required): string

Specifies the hostname or IP address of the remote LDAP server.
ds-cfg-remote-ldap-server-connect-timeout: integer(int32)

Default Value: 10000

Maximum time the proactive monitoring attempts to connect to the remote server before the connection fails. 0 means unlimited.
ds-cfg-remote-ldap-server-port(required): integer(int32)

Default Value: 389

Specifies the non-secured port to connect to the LDAP server.
ds-cfg-remote-ldap-server-psearch-read-timeout: integer(int32)

Default Value: 25

Maximum time the LDAP Server Extension waits for a response from the remote server for psearch before the connection fails.
ds-cfg-remote-ldap-server-read-only: boolean

Default Value: false

Indicates if the remote server is read-only. If set to true, all write operations are rejected by this LDAP Server Extension.
ds-cfg-remote-ldap-server-read-timeout: integer(int32)

Default Value: 10000

Maximum time the LDAP Server Extension waits for a response from the remote server before the connection fails. 0 means unlimited.
ds-cfg-remote-ldap-server-ssl-policy(required): string

Default Value: never

Allowed Values: [ "always", "never", "user" ]

Specifies the security policy to apply to the LDAP server.
ds-cfg-remote-ldap-server-ssl-port(required): integer(int32)

Default Value: 636

Specifies the secured port to connect to the LDAP server.
ds-cfg-saturation-precision: integer(int32)

Default Value: 5

The precision specifies the minimum value for the saturation index change to be taken into account.
ds-cfg-ssl-cipher-suite: array ds-cfg-ssl-cipher-suite

Specifies the names of the cipher suites that are that are used for secure connection to the LDAP server.
ds-cfg-ssl-client-alias: string

Specifies the alias to use for the client private key.
ds-cfg-ssl-key-manager-provider: string

Specifies key manager provider to use for the LDAP Server Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication.
ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol

Specifies the names of the SSL/TLS protocols that are used for secure connection to the LDAP server.
ds-cfg-ssl-trust-all: boolean

Default Value: false

Specifies to trust all remote servers.
ds-cfg-ssl-trust-manager-provider: string

Specifies trust manager provider to use for the LDAP Server Extension. This trust manager provider is mandatory unless the parameter ssl-trust-all is set to true.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-remote-ldap-server-ssl-policy",
        "ds-cfg-enabled",
        "ds-cfg-remote-ldap-server-port",
        "ds-cfg-remote-ldap-server-address",
        "ds-cfg-remote-ldap-server-ssl-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 Server Extension implementation. ",
            "readOnly":false,
            "default":"com.sun.dps.server.workflowelement.proxyldap.LDAPServerExtension",
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-read-timeout":{
            "description":"Maximum time the LDAP Server Extension waits for a response from the remote server before the connection fails. 0 means unlimited. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-remote-ldap-server-ssl-policy":{
            "description":"Specifies the security policy to apply to the LDAP server. ",
            "readOnly":false,
            "default":"never",
            "type":"string",
            "enum":[
                "always",
                "never",
                "user"
            ]
        },
        "ds-cfg-saturation-precision":{
            "description":"The precision specifies the minimum value for the saturation index change to be taken into account. ",
            "readOnly":false,
            "default":"5",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-pool-max-size":{
            "description":"Maximum size of a connection pool: this is the maximum number of connections a pool can allocate. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the maximum size of each pool is set to pool-max-size. ",
            "readOnly":false,
            "default":"1000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-monitoring-inactivity-timeout":{
            "description":"Time after which a connection is checked to avoid connection closure by the remote server. The value of this parameter must be superior to monitoring-check-interval. ",
            "readOnly":false,
            "default":"120000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the cipher suites that are that are used for secure connection to the LDAP server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-client-alias":{
            "description":"Specifies the alias to use for the client private key. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Extension is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-remote-ldap-server-port":{
            "description":"Specifies the non-secured port to connect to the LDAP server. ",
            "readOnly":false,
            "default":"389",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-pool-increment":{
            "description":"Increment by which the size of a connection pool is increased or decreased. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the incremental change of size of each pool is set to pool-increment. ",
            "readOnly":false,
            "default":"5",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-monitoring-check-interval":{
            "description":"Proactive monitoring check interval. ",
            "readOnly":false,
            "default":"30000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-pool-initial-size":{
            "description":"Initial size of a connection pool: this is the initial number of connections to be created when a pool is initialized. This is also the minimum size of a pool. If remote-ldap-server-ssl-policy is set to 'user', two pools are created and the initial size of each pool is set to pool-initial-size. ",
            "readOnly":false,
            "default":"10",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-key-manager-provider":{
            "description":"Specifies key manager provider to use for the LDAP Server Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-read-only":{
            "description":"Indicates if the remote server is read-only. If set to true, all write operations are rejected by this LDAP Server Extension. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-ssl-trust-manager-provider":{
            "description":"Specifies trust manager provider to use for the LDAP Server Extension. This trust manager provider is mandatory unless the parameter ssl-trust-all is set to true. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-monitoring-ping-timeout":{
            "description":"Maximum time the proactive monitoring attempts to ping the remote server. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-monitoring-statistics-interval":{
            "description":"Proactive statistics collection interval. ",
            "readOnly":false,
            "default":"30000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-pool-release-connection-interval":{
            "description":"Time after which the connection pool size can be reduced if enough connections are not used: if pool-increment connections or more are not used during pool-release-connection-interval, then these connections are removed from the pool. ",
            "readOnly":false,
            "default":"300000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-remote-ldap-server-connect-timeout":{
            "description":"Maximum time the proactive monitoring attempts to connect to the remote server before the connection fails. 0 means unlimited. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-directory-type":{
            "description":"Directory types used in ldap extension. ",
            "readOnly":false,
            "default":"oud",
            "type":"string",
            "enum":[
                "ad",
                "odsee",
                "oid",
                "oud"
            ]
        },
        "ds-cfg-monitoring-connect-timeout":{
            "description":"Maximum time the proactive monitoring attempts to connect to the remote server before the connections fails. 0 means unlimited. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL/TLS protocols that are used for secure connection to the LDAP server. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-trust-all":{
            "description":"Specifies to trust all remote servers. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-remote-ldap-server-address":{
            "description":"Specifies the hostname or IP address of the remote LDAP server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-psearch-read-timeout":{
            "description":"Maximum time the LDAP Server Extension waits for a response from the remote server for psearch before the connection fails. ",
            "readOnly":false,
            "default":"25",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-pool-max-write":{
            "description":"Maximum number of write connections a connection pool can allocate at the same time. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-remote-ldap-server-ssl-port":{
            "description":"Specifies the secured port to connect to the LDAP server. ",
            "readOnly":false,
            "default":"636",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-pool-use-max-write":{
            "description":"Indicates if the parameter pool-max-write is used. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-proxied-auth-use-v1":{
            "description":"If true, proxy authorization control V1 is used, otherwise V2 is used. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

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

Type: array

Specifies the names of the cipher suites that are that are used for secure connection to the LDAP server.

Show Source

Array of: string

{
    "description":"Specifies the names of the cipher suites that are that are used for secure connection to the LDAP server. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-ssl-protocol

Type: array

Specifies the names of the SSL/TLS protocols that are used for secure connection to the LDAP server.

Show Source

Array of: string

{
    "description":"Specifies the names of the SSL/TLS protocols that are used for secure connection to the LDAP server. ",
    "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."
        }
    }
}