Add, Search, Compare or Delete Join Workflow Element

post

/rest/v1/admin

Add, Search, Compare or Delete Join Workflow Element

Request

Supported Media Types
Body ()
Join Workflow Element that needs to be created
Root Schema : Join Workflow Element POSTRequest
Type: object
Show Source
  • 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.
  • Join Workflow Element Properties
  • 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
    LDAP controls to be sent to server for the LDAP operation.
  • 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.
  • 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.
  • 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
    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.
  • 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.
Nested Schema : Join Workflow Element Properties
Type: object
Show Source
Nested Schema : controls
Type: array
LDAP controls to be sent to server for the LDAP operation.
Show Source
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
Nested Schema : ds-cfg-dn-attribute
Type: array
DN syntax attributes whose DN need to be translated to that of Join WorkflowElement
Default Value: [ "member", "uniquemember", "memberof", "manager" ]
Show Source
Nested Schema : ds-cfg-virtual-attribute-creation-rule
Type: array
Create Virtual attributes based on attributes from individual participants
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Join Workflow Element SuccessResponse
Type: object
Show Source
Nested Schema : searchResultEntries
Type: array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Join Workflow Element SearchResultEntry
Type: object
Show Source
Nested Schema : Join Workflow Element Properties
Type: object
Show Source
Nested Schema : ds-cfg-dn-attribute
Type: array
DN syntax attributes whose DN need to be translated to that of Join WorkflowElement
Default Value: [ "member", "uniquemember", "memberof", "manager" ]
Show Source
Nested Schema : ds-cfg-virtual-attribute-creation-rule
Type: array
Create Virtual attributes based on attributes from individual participants
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source

201 Response

Created
Body ()
Root Schema : Join Workflow Element ADDResponse
Type: object
Show Source
Nested Schema : searchResultEntries
Type: array
Show Source
Nested Schema : Join Workflow Element SearchResultEntry
Type: object
Show Source
Nested Schema : Join Workflow Element Properties
Type: object
Show Source
Nested Schema : ds-cfg-dn-attribute
Type: array
DN syntax attributes whose DN need to be translated to that of Join WorkflowElement
Default Value: [ "member", "uniquemember", "memberof", "manager" ]
Show Source
Nested Schema : ds-cfg-virtual-attribute-creation-rule
Type: array
Create Virtual attributes based on attributes from individual participants
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source

204 Response

No content

406 Response

Not Acceptable
Body ()
Root Schema : ErrorResponse
Type: object
Show Source
Back to Top