Show Source

• msgType(required): string
  Default Value: urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse

  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",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
            "type":"string"
        },
        "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/Dynamic Groups Workflow Element SearchResultEntry"
            }
        }
    }
}

Show Source

• Array of: object Dynamic Groups Workflow Element SearchResultEntry

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

Show Source

• attributes(required): object Dynamic Groups Workflow Element 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/Dynamic Groups Workflow Element Properties"
        }
    }
}

Show Source

• 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.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-next-workflow-element",
        "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 Dynamic Groups Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.dynamicgroups.DynamicGroupsWorkflowElement",
            "type":"string"
        },
        "ds-cfg-check-url-base":{
            "description":"Boolean indicating whether or not to honor the base and scope specified in memberURL while performing membership test queries. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-fetch-both-static-dynamic":{
            "description":"Boolean indicating whether or not to fetch both static and dynamic groups which a user is a memer of. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-use-nativememberof-support":{
            "description":"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. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-user-search-base":{
            "description":"Optional value for a virtual search base that needs to override the base specified in an LDAP URL. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-expand-url":{
            "description":"Boolean indicating whether the dynamic groups have to be expanded or not. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-next-workflow-element":{
            "description":"Defines the next workflow element in the chain of workflow elements. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-member-attribute":{
            "description":"Name of the attribute that stores group member values. ",
            "readOnly":false,
            "default":"uniquemember",
            "type":"string"
        },
        "ds-cfg-global-search":{
            "description":"Boolean indicating whether or not to perform global search while expanding dynamic group. ",
            "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"
        },
        "ds-cfg-allowed-filter-count":{
            "description":"This is mainly used to optimize the performance of dynamicgroupsworkflowelement. ",
            "readOnly":false,
            "default":"100",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-nativememberof-attribute":{
            "description":"Optional value for which you can specify name of the native memberof attribute if supported by the backend. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

Show Source

• Array of: string

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

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