REST API for Oracle Unified Directory Administration

Modify a RDBMS Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a RDBMS Workflow Element by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

RDBMS Workflow Element 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 : RDBMS Workflow Element 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/RDBMS Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object RDBMS Workflow Element SearchResultEntry

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

Nested Schema : RDBMS Workflow Element SearchResultEntry

Type: object

Show Source

attributes(required): object RDBMS Workflow Element 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/RDBMS Workflow Element Properties"
        }
    }
}

Nested Schema : RDBMS Workflow Element Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-cache-invalidation-interval: string

Default Value: 60000ms

The lifetime of cached objects. This property is used when the cache invalidation property is set to 'ttl-cache-invalidation-policy'.
ds-cfg-cache-invalidation-policy: string

Default Value: no-expiry-cache-invalidation-policy

Allowed Values: [ "no-expiry-cache-invalidation-policy", "ttl-cache-invalidation-policy" ]

The policy that must be used to invalidate the cached data.
ds-cfg-cache-size: integer(int32)

Default Value: 1000

The number of database records to be cached.
ds-cfg-caching-scheme: string

Default Value: none

Allowed Values: [ "full", "hard-weak", "none", "soft", "soft-weak", "weak" ]

Select the scheme that must be used to cache database records. "none" is the recommended default.
ds-cfg-enabled(required): boolean

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-java-class(required): string

Default Value: com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement

Specifies the fully-qualified name of the Java class that provides the RDBMS Workflow Element implementation.
ds-cfg-password-attribute: string

Specifies the attribute type used to hold user passwords.
ds-cfg-password-storage-scheme: string

Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy.
ds-cfg-prefix-password-with-storage-scheme: boolean

Default Value: false

Specifies if passwords stored should be prefixed with scheme name or not.
ds-cfg-rdbms-extension(required): string

An RDBMS Extension contains the login details for connecting to the database. The Extension maintains a Connection Pool which is shared by all workflow elements referencing the extension.
ds-cfg-skip-dn-validation-attributes: array ds-cfg-skip-dn-validation-attributes

The DN validation will be skipped for the configured attributes
ds-cfg-suffix(required): string

suffix DN of all entries stored by this workflow element
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-suffix",
        "ds-cfg-enabled",
        "ds-cfg-rdbms-extension"
    ],
    "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 RDBMS Workflow Element implementation. ",
            "readOnly":false,
            "default":"com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement",
            "type":"string"
        },
        "ds-cfg-password-storage-scheme":{
            "description":"Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-skip-dn-validation-attributes":{
            "description":"The DN validation will be skipped for the configured attributes ",
            "readOnly":false,
            "default":[
                "member",
                "isMemberOf",
                "owner",
                "uniqueMember",
                "manager"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-size":{
            "description":"The number of database records to be cached. ",
            "readOnly":false,
            "default":"1000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the attribute type used to hold user passwords. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-cache-invalidation-policy":{
            "description":"The policy that must be used to invalidate the cached data. ",
            "readOnly":false,
            "default":"no-expiry-cache-invalidation-policy",
            "type":"string",
            "enum":[
                "no-expiry-cache-invalidation-policy",
                "ttl-cache-invalidation-policy"
            ]
        },
        "ds-cfg-prefix-password-with-storage-scheme":{
            "description":"Specifies if passwords stored should be prefixed with scheme name or not. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-cache-invalidation-interval":{
            "description":"The lifetime of cached objects. This property is used when the cache invalidation property is set to 'ttl-cache-invalidation-policy'. ",
            "readOnly":false,
            "default":"60000ms",
            "type":"string"
        },
        "ds-cfg-caching-scheme":{
            "description":"Select the scheme that must be used to cache database records. \"none\" is the recommended default. ",
            "readOnly":false,
            "default":"none",
            "type":"string",
            "enum":[
                "full",
                "hard-weak",
                "none",
                "soft",
                "soft-weak",
                "weak"
            ]
        },
        "ds-cfg-suffix":{
            "description":"suffix DN of all entries stored by this workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-rdbms-extension":{
            "description":"An RDBMS Extension contains the login details for connecting to the database. The Extension maintains a Connection Pool which is shared by all workflow elements referencing the extension. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

Nested Schema : ds-cfg-skip-dn-validation-attributes

Type: array

The DN validation will be skipped for the configured attributes

Default Value:

[
    "member",
    "isMemberOf",
    "owner",
    "uniqueMember",
    "manager"
]

Show Source

Array of: string

{
    "description":"The DN validation will be skipped for the configured attributes ",
    "readOnly":false,
    "default":[
        "member",
        "isMemberOf",
        "owner",
        "uniqueMember",
        "manager"
    ],
    "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."
        }
    }
}