REST API for Oracle Unified Directory Administration

Modify a ForkJoin Workflow Element by DN

patch

/rest/v1/admin/{dn}

Modify a ForkJoin Workflow Element by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be modified

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

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object ForkJoin Workflow Element SearchResultEntry

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

Nested Schema : ForkJoin Workflow Element SearchResultEntry

Type: object

Show Source

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

Nested Schema : ForkJoin Workflow Element Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-cache-size: integer(int32)

Default Value: 10000

The maximum number of entries that can be stored in the cache used to filter out entry duplicates.
ds-cfg-dn-attribute: array ds-cfg-dn-attribute

DN syntax attributes whose DN need to be translated to that of ForkJoin Workflow Element.
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.forkjoin.ForkJoinWorkflowElement

Specifies the fully-qualified name of the Java class that provides the ForkJoin Workflow Element implementation.
ds-cfg-join-suffix: string

Read Only: true

The virtual DN that will be exposed by the ForkJoin Workflow Element
ds-cfg-password-attribute: string

Default Value: userpassword

Specifies the names of the attribute that contains the password in the user entry.
ds-cfg-populate-joinedentrydn: boolean

Default Value: false

Decides if the attribute "joinedentrydn" has to be populated in the joined entries.
ds-cfg-primary-and-secondary-attributes: array ds-cfg-primary-and-secondary-attributes

A list of attributes that are present in both the primary and secondary participants and which the application can use in the search filter. The attributes identified by the PrimaryAndSecondaryAttributes configuration parameter cannot also be identified by the SecondaryOnlyAttributes configuration parameter.
ds-cfg-save-password-on-successful-bind: boolean

Default Value: false

Indicates whether the password should be saved in the primary entry when authentication succeeds.
ds-cfg-secondary-only-attributes: array ds-cfg-secondary-only-attributes

A list of attributes that are present only in the secondary participant and which the application can use in the search filter. The attributes identified by the SecondaryOnlyAttributes configuration parameter cannot also be identified by the PrimaryAndSecondaryAttributes configuration parameter.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled"
    ],
    "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 ForkJoin Workflow Element implementation. ",
            "readOnly":false,
            "default":"com.oracle.dps.server.workflowelement.forkjoin.ForkJoinWorkflowElement",
            "type":"string"
        },
        "ds-cfg-dn-attribute":{
            "description":"DN syntax attributes whose DN need to be translated to that of ForkJoin Workflow Element. ",
            "readOnly":false,
            "default":[
                "member",
                "uniquemember",
                "memberof",
                "manager"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-primary-and-secondary-attributes":{
            "description":"A list of attributes that are present in both the primary and secondary participants and which the application can use in the search filter. The attributes identified by the PrimaryAndSecondaryAttributes configuration parameter cannot also be identified by the SecondaryOnlyAttributes configuration parameter. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-secondary-only-attributes":{
            "description":"A list of attributes that are present only in the secondary participant and which the application can use in the search filter. The attributes identified by the SecondaryOnlyAttributes configuration parameter cannot also be identified by the PrimaryAndSecondaryAttributes configuration parameter. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-size":{
            "description":"The maximum number of entries that can be stored in the cache used to filter out entry duplicates. ",
            "readOnly":false,
            "default":"10000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-suffix":{
            "description":"The virtual DN that will be exposed by the ForkJoin Workflow Element ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the names of the attribute that contains the password in the user entry. ",
            "readOnly":false,
            "default":"userpassword",
            "type":"string"
        },
        "ds-cfg-save-password-on-successful-bind":{
            "description":"Indicates whether the password should be saved in the primary entry when authentication succeeds. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-populate-joinedentrydn":{
            "description":"Decides if the attribute \"joinedentrydn\" has to be populated in the joined entries. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-dn-attribute

Type: array

DN syntax attributes whose DN need to be translated to that of ForkJoin Workflow Element.

Default Value:

[
    "member",
    "uniquemember",
    "memberof",
    "manager"
]

Show Source

Array of: string

{
    "description":"DN syntax attributes whose DN need to be translated to that of ForkJoin Workflow Element. ",
    "readOnly":false,
    "default":[
        "member",
        "uniquemember",
        "memberof",
        "manager"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-primary-and-secondary-attributes

Type: array

A list of attributes that are present in both the primary and secondary participants and which the application can use in the search filter. The attributes identified by the PrimaryAndSecondaryAttributes configuration parameter cannot also be identified by the SecondaryOnlyAttributes configuration parameter.

Show Source

Array of: string

{
    "description":"A list of attributes that are present in both the primary and secondary participants and which the application can use in the search filter. The attributes identified by the PrimaryAndSecondaryAttributes configuration parameter cannot also be identified by the SecondaryOnlyAttributes configuration parameter. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-secondary-only-attributes

Type: array

A list of attributes that are present only in the secondary participant and which the application can use in the search filter. The attributes identified by the SecondaryOnlyAttributes configuration parameter cannot also be identified by the PrimaryAndSecondaryAttributes configuration parameter.

Show Source

Array of: string

{
    "description":"A list of attributes that are present only in the secondary participant and which the application can use in the search filter. The attributes identified by the SecondaryOnlyAttributes configuration parameter cannot also be identified by the PrimaryAndSecondaryAttributes configuration parameter. ",
    "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."
        }
    }
}