Add, Search, Compare or Delete Dynamic Groups Workflow Element
post
/rest/v1/admin
Add, Search, Compare or Delete Dynamic Groups Workflow Element
Request
Supported Media Types
- application/json
Dynamic Groups Workflow Element that needs to be created
Root Schema : Dynamic Groups Workflow Element POSTRequest
Type:
Show Source
object
-
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 Dynamic Groups Workflow Element 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.
Nested Schema : Dynamic Groups Workflow Element Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
ds-cfg-allowed-filter-count:
integer(int32)
Default Value:
100
This is mainly used to optimize the performance of dynamicgroupsworkflowelement. -
ds-cfg-check-url-base:
boolean
Default Value:
false
Boolean indicating whether or not to honor the base and scope specified in memberURL while performing membership test queries. -
ds-cfg-enabled(required):
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-expand-url:
boolean
Boolean indicating whether the dynamic groups have to be expanded or not.
-
ds-cfg-fetch-both-static-dynamic:
boolean
Default Value:
false
Boolean indicating whether or not to fetch both static and dynamic groups which a user is a memer of. -
ds-cfg-global-search:
boolean
Default Value:
false
Boolean indicating whether or not to perform global search while expanding dynamic group. -
ds-cfg-java-class(required):
string
Default Value:
org.opends.server.workflowelement.ovdplugin.dynamicgroups.DynamicGroupsWorkflowElement
Specifies the fully-qualified name of the Java class that provides the Dynamic Groups Workflow Element implementation. -
ds-cfg-member-attribute:
string
Default Value:
uniquemember
Name of the attribute that stores group member values. -
ds-cfg-nativememberof-attribute:
string
Optional value for which you can specify name of the native memberof attribute if supported by the backend.
-
ds-cfg-next-workflow-element(required):
string
Defines the next workflow element in the chain of workflow elements.
-
ds-cfg-use-nativememberof-support:
boolean
Default Value:
false
Boolean indicating whether or not to use the native memberof support from the backend directory,if supported by the backend directory.To improve the performance of dynamicgroupsworkflowelement related queries. -
ds-cfg-user-search-base:
string
Optional value for a virtual search base that needs to override the base specified in an LDAP URL.
-
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
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
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Dynamic Groups Workflow Element SuccessResponse
Type:
Show Source
object
-
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.
Nested Schema : searchResultEntries
Type:
array
Number of search result entries returned after the LDAP operation.
Show Source
Nested Schema : Dynamic Groups Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes(required):
object Dynamic Groups Workflow Element Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : Dynamic Groups Workflow Element Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
ds-cfg-allowed-filter-count:
integer(int32)
Default Value:
100
This is mainly used to optimize the performance of dynamicgroupsworkflowelement. -
ds-cfg-check-url-base:
boolean
Default Value:
false
Boolean indicating whether or not to honor the base and scope specified in memberURL while performing membership test queries. -
ds-cfg-enabled(required):
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-expand-url:
boolean
Boolean indicating whether the dynamic groups have to be expanded or not.
-
ds-cfg-fetch-both-static-dynamic:
boolean
Default Value:
false
Boolean indicating whether or not to fetch both static and dynamic groups which a user is a memer of. -
ds-cfg-global-search:
boolean
Default Value:
false
Boolean indicating whether or not to perform global search while expanding dynamic group. -
ds-cfg-java-class(required):
string
Default Value:
org.opends.server.workflowelement.ovdplugin.dynamicgroups.DynamicGroupsWorkflowElement
Specifies the fully-qualified name of the Java class that provides the Dynamic Groups Workflow Element implementation. -
ds-cfg-member-attribute:
string
Default Value:
uniquemember
Name of the attribute that stores group member values. -
ds-cfg-nativememberof-attribute:
string
Optional value for which you can specify name of the native memberof attribute if supported by the backend.
-
ds-cfg-next-workflow-element(required):
string
Defines the next workflow element in the chain of workflow elements.
-
ds-cfg-use-nativememberof-support:
boolean
Default Value:
false
Boolean indicating whether or not to use the native memberof support from the backend directory,if supported by the backend directory.To improve the performance of dynamicgroupsworkflowelement related queries. -
ds-cfg-user-search-base:
string
Optional value for a virtual search base that needs to override the base specified in an LDAP URL.
-
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
201 Response
Created
Root Schema : Dynamic Groups Workflow Element ADDResponse
Type:
Show Source
object
-
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.
Nested Schema : Dynamic Groups Workflow Element SearchResultEntry
Type:
Show Source
object
-
attributes(required):
object Dynamic Groups Workflow Element Properties
-
dn(required):
string
LDAP DN of the entry to be created
Nested Schema : Dynamic Groups Workflow Element Properties
Type:
Show Source
object
-
cn:
string
CN (common name) of the entry
-
ds-cfg-allowed-filter-count:
integer(int32)
Default Value:
100
This is mainly used to optimize the performance of dynamicgroupsworkflowelement. -
ds-cfg-check-url-base:
boolean
Default Value:
false
Boolean indicating whether or not to honor the base and scope specified in memberURL while performing membership test queries. -
ds-cfg-enabled(required):
boolean
Indicates whether the Workflow Element is enabled for use in the server.
-
ds-cfg-expand-url:
boolean
Boolean indicating whether the dynamic groups have to be expanded or not.
-
ds-cfg-fetch-both-static-dynamic:
boolean
Default Value:
false
Boolean indicating whether or not to fetch both static and dynamic groups which a user is a memer of. -
ds-cfg-global-search:
boolean
Default Value:
false
Boolean indicating whether or not to perform global search while expanding dynamic group. -
ds-cfg-java-class(required):
string
Default Value:
org.opends.server.workflowelement.ovdplugin.dynamicgroups.DynamicGroupsWorkflowElement
Specifies the fully-qualified name of the Java class that provides the Dynamic Groups Workflow Element implementation. -
ds-cfg-member-attribute:
string
Default Value:
uniquemember
Name of the attribute that stores group member values. -
ds-cfg-nativememberof-attribute:
string
Optional value for which you can specify name of the native memberof attribute if supported by the backend.
-
ds-cfg-next-workflow-element(required):
string
Defines the next workflow element in the chain of workflow elements.
-
ds-cfg-use-nativememberof-support:
boolean
Default Value:
false
Boolean indicating whether or not to use the native memberof support from the backend directory,if supported by the backend directory.To improve the performance of dynamicgroupsworkflowelement related queries. -
ds-cfg-user-search-base:
string
Optional value for a virtual search base that needs to override the base specified in an LDAP URL.
-
objectclass(required):
array objectclass
Objectclass(es) which this entry belongs to.
204 Response
No content
406 Response
Not Acceptable
Root Schema : ErrorResponse
Type:
Show Source
object
-
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