Add, Search, Compare or Delete Transformations Workflow Element

post

/rest/v1/admin

Add, Search, Compare or Delete Transformations Workflow Element

Request

Supported Media Types
Body ()
Transformations Workflow Element that needs to be created
Root Schema : Transformations 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.
  • Transformations 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 : Transformations 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-entry-parent-suffix
Type: array
Specifies an parent DN of the operation DN for the transformations to apply. When several values are specified, the entry is transformed when at least one parent DN specified is a parent DN of the entry DN. When not specified, all entries (that match other potential conditions) are transformed.
Show Source
Nested Schema : ds-cfg-excluded-operation
Type: array
Specifies operations on which transformations never apply. Example: When one transformation type normally processes ADD and MODIFY operation, it is possible to exclude MODIFY and thus to make the transformation only process ADD operation. When the list is empty, the operation processed depend on each type of transformation with no restriction.
Allowed Values: [ "add", "bind", "compare", "delete", "extended", "modify", "modifydn", "search" ]
Show Source
Nested Schema : ds-cfg-transformation
Type: array
Specifies the transformations that are applied.
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 : Transformations 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 : Transformations Workflow Element SearchResultEntry
Type: object
Show Source
Nested Schema : Transformations Workflow Element Properties
Type: object
Show Source
Nested Schema : ds-cfg-entry-parent-suffix
Type: array
Specifies an parent DN of the operation DN for the transformations to apply. When several values are specified, the entry is transformed when at least one parent DN specified is a parent DN of the entry DN. When not specified, all entries (that match other potential conditions) are transformed.
Show Source
Nested Schema : ds-cfg-excluded-operation
Type: array
Specifies operations on which transformations never apply. Example: When one transformation type normally processes ADD and MODIFY operation, it is possible to exclude MODIFY and thus to make the transformation only process ADD operation. When the list is empty, the operation processed depend on each type of transformation with no restriction.
Allowed Values: [ "add", "bind", "compare", "delete", "extended", "modify", "modifydn", "search" ]
Show Source
Nested Schema : ds-cfg-transformation
Type: array
Specifies the transformations that are applied.
Show Source
Nested Schema : objectclass
Type: array
Objectclass(es) which this entry belongs to.
Show Source

201 Response

Created
Body ()
Root Schema : Transformations Workflow Element ADDResponse
Type: object
Show Source
Nested Schema : searchResultEntries
Type: array
Show Source
Nested Schema : Transformations Workflow Element SearchResultEntry
Type: object
Show Source
Nested Schema : Transformations Workflow Element Properties
Type: object
Show Source
Nested Schema : ds-cfg-entry-parent-suffix
Type: array
Specifies an parent DN of the operation DN for the transformations to apply. When several values are specified, the entry is transformed when at least one parent DN specified is a parent DN of the entry DN. When not specified, all entries (that match other potential conditions) are transformed.
Show Source
Nested Schema : ds-cfg-excluded-operation
Type: array
Specifies operations on which transformations never apply. Example: When one transformation type normally processes ADD and MODIFY operation, it is possible to exclude MODIFY and thus to make the transformation only process ADD operation. When the list is empty, the operation processed depend on each type of transformation with no restriction.
Allowed Values: [ "add", "bind", "compare", "delete", "extended", "modify", "modifydn", "search" ]
Show Source
Nested Schema : ds-cfg-transformation
Type: array
Specifies the transformations that are applied.
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