Admin REST APIs for Oracle Unified Directory

Add, Search, Compare or Delete Fork Join Workflow Element

post

/rest/v1/admin

Add, Search, Compare or Delete Fork Join Workflow Element

Request

Supported Media Types

application/json

Fork Join Workflow Element that needs to be created

Root Schema : Fork Join Workflow Element POSTRequest

Type: object

Show Source

assertion(optional): 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(optional): object Fork Join Workflow Element Properties
base(optional): 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(optional): array controls

LDAP controls to be sent to server for the LDAP operation.
dn(optional): 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(optional): 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: 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(optional): 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(optional): 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/Fork Join Workflow Element 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 : Fork Join Workflow Element Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-cache-size(optional): 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(optional): array ds-cfg-dn-attribute

DN syntax attributes whose DN need to be translated to that of Fork Join Workflow Element.
ds-cfg-enabled: boolean

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

Default Value: com.oracle.dps.server.workflowelement.forkjoin.ForkJoinWorkflowElement

Specifies the fully-qualified name of the Java class that provides the Fork Join Workflow Element implementation.
ds-cfg-join-suffix(optional): string

Read Only: true

The virtual DN that will be exposed by the Fork Join Workflow Element
ds-cfg-password-attribute(optional): string

Default Value: userpassword

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

Default Value: false

Decides if the attribute "joinedentrydn" has to be populated in the joined entries.
ds-cfg-primary-and-secondary-attributes(optional): 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(optional): boolean

Default Value: false

Indicates whether the password should be saved in the primary entry when authentication succeeds.
ds-cfg-secondary-only-attributes(optional): 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: 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 Fork Join 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 Fork Join 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 Fork Join 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 : controls

Type: array

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

Show Source

[0]: 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

[0]: 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-dn-attribute

Type: array

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

Default Value:

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

Show Source

[0]: string

{
    "description":"DN syntax attributes whose DN need to be translated to that of Fork Join 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

[0]: 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

[0]: 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

[0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Root Schema : Fork Join Workflow Element SuccessResponse

Type: object

Show Source

compareResult(optional): boolean

Indicates the result of LDAP compare operation.
msgType: 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: array searchResultEntries

Number of search result entries returned after the LDAP operation.
totalResults: 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/Fork Join Workflow Element 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

[0]: object Fork Join Workflow Element SearchResultEntry

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

Nested Schema : Fork Join Workflow Element SearchResultEntry

Type: object

Show Source

attributes: object Fork Join Workflow Element Properties
dn: 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/Fork Join Workflow Element Properties"
        }
    }
}

Nested Schema : Fork Join Workflow Element Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-cache-size(optional): 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(optional): array ds-cfg-dn-attribute

DN syntax attributes whose DN need to be translated to that of Fork Join Workflow Element.
ds-cfg-enabled: boolean

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

Default Value: com.oracle.dps.server.workflowelement.forkjoin.ForkJoinWorkflowElement

Specifies the fully-qualified name of the Java class that provides the Fork Join Workflow Element implementation.
ds-cfg-join-suffix(optional): string

Read Only: true

The virtual DN that will be exposed by the Fork Join Workflow Element
ds-cfg-password-attribute(optional): string

Default Value: userpassword

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

Default Value: false

Decides if the attribute "joinedentrydn" has to be populated in the joined entries.
ds-cfg-primary-and-secondary-attributes(optional): 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(optional): boolean

Default Value: false

Indicates whether the password should be saved in the primary entry when authentication succeeds.
ds-cfg-secondary-only-attributes(optional): 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: 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 Fork Join 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 Fork Join 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 Fork Join 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 Fork Join Workflow Element.

Default Value:

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

Show Source

[0]: string

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

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

Type: array

Show Source

[0]: 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

Show Source

[0]: 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

[0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

201 Response

Created

Root Schema : Fork Join Workflow Element ADDResponse

Type: object

Show Source

msgType: string

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

The REST message type
searchResultEntries: array searchResultEntries
totalResults: 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/Fork Join Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Show Source

[0]: object Fork Join Workflow Element SearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Fork Join Workflow Element SearchResultEntry"
    }
}

Nested Schema : Fork Join Workflow Element SearchResultEntry

Type: object

Show Source

attributes: object Fork Join Workflow Element Properties
dn: 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/Fork Join Workflow Element Properties"
        }
    }
}

Nested Schema : Fork Join Workflow Element Properties

Type: object

Show Source

cn(optional): string

CN (common name) of the entry
ds-cfg-cache-size(optional): 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(optional): array ds-cfg-dn-attribute

DN syntax attributes whose DN need to be translated to that of Fork Join Workflow Element.
ds-cfg-enabled: boolean

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

Default Value: com.oracle.dps.server.workflowelement.forkjoin.ForkJoinWorkflowElement

Specifies the fully-qualified name of the Java class that provides the Fork Join Workflow Element implementation.
ds-cfg-join-suffix(optional): string

Read Only: true

The virtual DN that will be exposed by the Fork Join Workflow Element
ds-cfg-password-attribute(optional): string

Default Value: userpassword

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

Default Value: false

Decides if the attribute "joinedentrydn" has to be populated in the joined entries.
ds-cfg-primary-and-secondary-attributes(optional): 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(optional): boolean

Default Value: false

Indicates whether the password should be saved in the primary entry when authentication succeeds.
ds-cfg-secondary-only-attributes(optional): 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: 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 Fork Join 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 Fork Join 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 Fork Join 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 Fork Join Workflow Element.

Default Value:

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

Show Source

[0]: string

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

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

Type: array

Show Source

[0]: 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

Show Source

[0]: 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

[0]: 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(optional): integer(int32)

Specifies the LDAP error code returned for the operation.
message: string

Error message returned returned for the operation.
msgType: 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."
        }
    }
}