REST API for Oracle Unified Directory Administration

Add, Search, Compare or Delete Secondary ForkJoin Participant

post

/rest/v1/admin

Add, Search, Compare or Delete Secondary ForkJoin Participant

Request

Supported Media Types

application/json

Secondary ForkJoin Participant that needs to be created

Root Schema : Secondary ForkJoin Participant POSTRequest

Type: object

Show Source

assertion: string

Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.
attributes: object Secondary ForkJoin Participant Properties
base: string

Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation
controls: array controls

LDAP controls to be sent to server for the LDAP operation.
dn: string

LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.
filter: string

Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
msgType(required): string

Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

The REST message type
requiredAttributes: array requiredAttributes

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.
scope: string

Allowed Values: [ "base", "sub", "one" ]

Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Secondary ForkJoin Participant Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

Nested Schema : Secondary ForkJoin Participant Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-enabled-operation: array ds-cfg-enabled-operation

This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not.
ds-cfg-join-condition: string

Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax.
ds-cfg-join-policy(required): string

Default Value: left-outer-join

Allowed Values: [ "full-outer-join", "left-outer-join", "standard-join" ]

The Join policy configuration for this ForkJoin WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join
ds-cfg-joiner-type(required): string

Default Value: one-to-one

Allowed Values: [ "many-to-one", "one-to-many", "one-to-one", "shadow" ]

The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow
ds-cfg-non-retrievable-attribute: array ds-cfg-non-retrievable-attribute

Defines the list of non-retrievable attributes for this participant
ds-cfg-non-storable-attribute: array ds-cfg-non-storable-attribute

Defines the list of non-storable attributes for this participant. This overrides the storable list.
ds-cfg-participant-bind-priority: integer(int32)

Default Value: 0

Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority.
ds-cfg-participant-criticality: string

Default Value: true

Allowed Values: [ "false", "partial", "true" ]

When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations.
ds-cfg-participant-dn(required): string

The real DN that is exposed by the participating workflow element
ds-cfg-participants-join-rule(required): string

Default Value:

The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values.
ds-cfg-participating-workflow-element(required): string

Name of the Participating WorkFlow Element
ds-cfg-retrievable-attribute: array ds-cfg-retrievable-attribute

Defines the list of retrievable attributes for this participant
ds-cfg-storable-attribute: array ds-cfg-storable-attribute

Defines the list of storable attributes for this participant
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-participating-workflow-element",
        "ds-cfg-participants-join-rule",
        "ds-cfg-join-policy",
        "ds-cfg-participant-dn",
        "ds-cfg-joiner-type"
    ],
    "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-join-condition":{
            "description":"Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participating-workflow-element":{
            "description":"Name of the Participating WorkFlow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-non-storable-attribute":{
            "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-operation":{
            "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
            "readOnly":false,
            "default":[
                "search",
                "compare",
                "delete",
                "modify"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participants-join-rule":{
            "description":"The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-participant-bind-priority":{
            "description":"Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-policy":{
            "description":"The Join policy configuration for this ForkJoin WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join ",
            "readOnly":false,
            "default":"left-outer-join",
            "type":"string",
            "enum":[
                "full-outer-join",
                "left-outer-join",
                "standard-join"
            ]
        },
        "ds-cfg-non-retrievable-attribute":{
            "description":"Defines the list of non-retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-joiner-type":{
            "description":"The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow ",
            "readOnly":false,
            "default":"one-to-one",
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one",
                "shadow"
            ]
        },
        "ds-cfg-retrievable-attribute":{
            "description":"Defines the list of retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-criticality":{
            "description":"When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        }
    }
}

Nested Schema : controls

Type: array

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

Show Source

Array of: string

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

Nested Schema : requiredAttributes

Type: array

List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.

Show Source

Array of: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-enabled-operation

Type: array

This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not.

Default Value:

[
    "search",
    "compare",
    "delete",
    "modify"
]

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "modify",
    "modifydn",
    "search"
]

Show Source

Array of: string

{
    "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
    "readOnly":false,
    "default":[
        "search",
        "compare",
        "delete",
        "modify"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-non-retrievable-attribute

Type: array

Defines the list of non-retrievable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of non-retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-non-storable-attribute

Type: array

Defines the list of non-storable attributes for this participant. This overrides the storable list.

Show Source

Array of: string

{
    "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-retrievable-attribute

Type: array

Defines the list of retrievable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-storable-attribute

Type: array

Defines the list of storable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of storable attributes for this participant ",
    "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"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Secondary ForkJoin Participant SuccessResponse

Type: object

Show Source

compareResult: boolean

Indicates the result of LDAP compare operation.
msgType(required): string

Allowed Values: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

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",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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/Secondary ForkJoin Participant SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Secondary ForkJoin Participant SearchResultEntry

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

Nested Schema : Secondary ForkJoin Participant SearchResultEntry

Type: object

Show Source

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

Nested Schema : Secondary ForkJoin Participant Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-enabled-operation: array ds-cfg-enabled-operation

This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not.
ds-cfg-join-condition: string

Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax.
ds-cfg-join-policy(required): string

Default Value: left-outer-join

Allowed Values: [ "full-outer-join", "left-outer-join", "standard-join" ]

The Join policy configuration for this ForkJoin WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join
ds-cfg-joiner-type(required): string

Default Value: one-to-one

Allowed Values: [ "many-to-one", "one-to-many", "one-to-one", "shadow" ]

The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow
ds-cfg-non-retrievable-attribute: array ds-cfg-non-retrievable-attribute

Defines the list of non-retrievable attributes for this participant
ds-cfg-non-storable-attribute: array ds-cfg-non-storable-attribute

Defines the list of non-storable attributes for this participant. This overrides the storable list.
ds-cfg-participant-bind-priority: integer(int32)

Default Value: 0

Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority.
ds-cfg-participant-criticality: string

Default Value: true

Allowed Values: [ "false", "partial", "true" ]

When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations.
ds-cfg-participant-dn(required): string

The real DN that is exposed by the participating workflow element
ds-cfg-participants-join-rule(required): string

Default Value:

The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values.
ds-cfg-participating-workflow-element(required): string

Name of the Participating WorkFlow Element
ds-cfg-retrievable-attribute: array ds-cfg-retrievable-attribute

Defines the list of retrievable attributes for this participant
ds-cfg-storable-attribute: array ds-cfg-storable-attribute

Defines the list of storable attributes for this participant
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-participating-workflow-element",
        "ds-cfg-participants-join-rule",
        "ds-cfg-join-policy",
        "ds-cfg-participant-dn",
        "ds-cfg-joiner-type"
    ],
    "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-join-condition":{
            "description":"Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participating-workflow-element":{
            "description":"Name of the Participating WorkFlow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-non-storable-attribute":{
            "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-operation":{
            "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
            "readOnly":false,
            "default":[
                "search",
                "compare",
                "delete",
                "modify"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participants-join-rule":{
            "description":"The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-participant-bind-priority":{
            "description":"Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-policy":{
            "description":"The Join policy configuration for this ForkJoin WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join ",
            "readOnly":false,
            "default":"left-outer-join",
            "type":"string",
            "enum":[
                "full-outer-join",
                "left-outer-join",
                "standard-join"
            ]
        },
        "ds-cfg-non-retrievable-attribute":{
            "description":"Defines the list of non-retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-joiner-type":{
            "description":"The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow ",
            "readOnly":false,
            "default":"one-to-one",
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one",
                "shadow"
            ]
        },
        "ds-cfg-retrievable-attribute":{
            "description":"Defines the list of retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-criticality":{
            "description":"When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        }
    }
}

Nested Schema : ds-cfg-enabled-operation

Type: array

Default Value:

[
    "search",
    "compare",
    "delete",
    "modify"
]

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "modify",
    "modifydn",
    "search"
]

Show Source

Array of: string

{
    "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
    "readOnly":false,
    "default":[
        "search",
        "compare",
        "delete",
        "modify"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-non-retrievable-attribute

Type: array

Defines the list of non-retrievable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of non-retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-non-storable-attribute

Type: array

Defines the list of non-storable attributes for this participant. This overrides the storable list.

Show Source

Array of: string

{
    "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-retrievable-attribute

Type: array

Defines the list of retrievable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-storable-attribute

Type: array

Defines the list of storable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of storable attributes for this participant ",
    "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"
    }
}

201 Response

Created

Root Schema : Secondary ForkJoin Participant ADDResponse

Type: object

Show Source

msgType(required): string

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

The REST message type
searchResultEntries(required): array searchResultEntries
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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Secondary ForkJoin Participant SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

Array of: object Secondary ForkJoin Participant SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Secondary ForkJoin Participant SearchResultEntry"
    }
}

Nested Schema : Secondary ForkJoin Participant SearchResultEntry

Type: object

Show Source

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

Nested Schema : Secondary ForkJoin Participant Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-enabled-operation: array ds-cfg-enabled-operation

This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not.
ds-cfg-join-condition: string

Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax.
ds-cfg-join-policy(required): string

Default Value: left-outer-join

Allowed Values: [ "full-outer-join", "left-outer-join", "standard-join" ]

The Join policy configuration for this ForkJoin WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join
ds-cfg-joiner-type(required): string

Default Value: one-to-one

Allowed Values: [ "many-to-one", "one-to-many", "one-to-one", "shadow" ]

The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow
ds-cfg-non-retrievable-attribute: array ds-cfg-non-retrievable-attribute

Defines the list of non-retrievable attributes for this participant
ds-cfg-non-storable-attribute: array ds-cfg-non-storable-attribute

Defines the list of non-storable attributes for this participant. This overrides the storable list.
ds-cfg-participant-bind-priority: integer(int32)

Default Value: 0

Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority.
ds-cfg-participant-criticality: string

Default Value: true

Allowed Values: [ "false", "partial", "true" ]

When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations.
ds-cfg-participant-dn(required): string

The real DN that is exposed by the participating workflow element
ds-cfg-participants-join-rule(required): string

Default Value:

The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values.
ds-cfg-participating-workflow-element(required): string

Name of the Participating WorkFlow Element
ds-cfg-retrievable-attribute: array ds-cfg-retrievable-attribute

Defines the list of retrievable attributes for this participant
ds-cfg-storable-attribute: array ds-cfg-storable-attribute

Defines the list of storable attributes for this participant
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-participating-workflow-element",
        "ds-cfg-participants-join-rule",
        "ds-cfg-join-policy",
        "ds-cfg-participant-dn",
        "ds-cfg-joiner-type"
    ],
    "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-join-condition":{
            "description":"Only the entries satisfying the join condition are considered for join in this participant where the condition is defined. It is of the LDAPFilter syntax. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-participating-workflow-element":{
            "description":"Name of the Participating WorkFlow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-non-storable-attribute":{
            "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled-operation":{
            "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
            "readOnly":false,
            "default":[
                "search",
                "compare",
                "delete",
                "modify"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "add",
                "bind",
                "compare",
                "delete",
                "modify",
                "modifydn",
                "search"
            ]
        },
        "ds-cfg-storable-attribute":{
            "description":"Defines the list of storable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participants-join-rule":{
            "description":"The join rule defined between the primary and the secondary participants, that is used to join entries between them. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form [attributeName]=[attributeName], where the right [attributeName] refers to the primary participant and the left [attributeName] refers to the secondary participant. [attributeName] are substitued with actual values. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-participant-bind-priority":{
            "description":"Determines the priority of this participant when serving bind requests, if BIND is specified as enabled operation in this participant. It can take any values greater than or equal to zero. The priority decreases as the number increases - Lower the number, higher the priority; 0 being the highest priority. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-join-policy":{
            "description":"The Join policy configuration for this ForkJoin WorkflowElement, which decides whatentries are returned from Search Operation. This is analogous to Database join. It can be one of the following: 1) standard-join 2) left-outer-join 3) full-outer-join ",
            "readOnly":false,
            "default":"left-outer-join",
            "type":"string",
            "enum":[
                "full-outer-join",
                "left-outer-join",
                "standard-join"
            ]
        },
        "ds-cfg-non-retrievable-attribute":{
            "description":"Defines the list of non-retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-dn":{
            "description":"The real DN that is exposed by the participating workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-joiner-type":{
            "description":"The Joiner Type used to join two participants defined in this participant configuration. It can be one of the following. 1. OneToOne 2. OneToMany 3. ManyToOne 4. Shadow ",
            "readOnly":false,
            "default":"one-to-one",
            "type":"string",
            "enum":[
                "many-to-one",
                "one-to-many",
                "one-to-one",
                "shadow"
            ]
        },
        "ds-cfg-retrievable-attribute":{
            "description":"Defines the list of retrievable attributes for this participant ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-participant-criticality":{
            "description":"When a search operation done against a participant fails due to a communication error, Join WorkflowElement reacts based on the Criticality setting. It can be set to one of the following values - true, false, partial. Criticality is honored only for Search operations. ",
            "readOnly":false,
            "default":"true",
            "type":"string",
            "enum":[
                "false",
                "partial",
                "true"
            ]
        }
    }
}

Nested Schema : ds-cfg-enabled-operation

Type: array

Default Value:

[
    "search",
    "compare",
    "delete",
    "modify"
]

Allowed Values:

[
    "add",
    "bind",
    "compare",
    "delete",
    "modify",
    "modifydn",
    "search"
]

Show Source

Array of: string

{
    "description":"This participant participates only in those LDAP operations specified in this parameter. By default, it participates only in SEARCH, COMPARE, DELETE and MODIFY operations. If BIND operation is specified in enabled operations, then the bind priority configured is honoured. Else, it is not. ",
    "readOnly":false,
    "default":[
        "search",
        "compare",
        "delete",
        "modify"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "add",
        "bind",
        "compare",
        "delete",
        "modify",
        "modifydn",
        "search"
    ]
}

Nested Schema : ds-cfg-non-retrievable-attribute

Type: array

Defines the list of non-retrievable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of non-retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-non-storable-attribute

Type: array

Defines the list of non-storable attributes for this participant. This overrides the storable list.

Show Source

Array of: string

{
    "description":"Defines the list of non-storable attributes for this participant. This overrides the storable list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-retrievable-attribute

Type: array

Defines the list of retrievable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of retrievable attributes for this participant ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-storable-attribute

Type: array

Defines the list of storable attributes for this participant

Show Source

Array of: string

{
    "description":"Defines the list of storable attributes for this participant ",
    "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"
    }
}

204 Response

No content

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