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/Eus Workflow Element SearchResultEntry"
            }
        }
    }
}

Show Source

• Array of: object Eus Workflow Element SearchResultEntry

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

Show Source

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

Show Source

• cn: string
  CN (common name) of the entry
• ds-cfg-certificate-matching-rule: string
  Default Value: certificate-match

  Allowed Values: [ "certificate-match", "certificate-or-dn-match", "dn-match", "mapper-match", "mapper-or-certificate-or-dn-match" ]

  Specifies the method used for certificate authentication.
• ds-cfg-enabled(required): boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-eus-realm(required): string
  Identifies the part of the DIT the EUS workflow element applies to. The value cannot be the null DN.
• ds-cfg-java-class(required): string
  Default Value: org.opends.server.workflowelement.ovdplugin.eus.EusWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the Eus Workflow Element implementation.
• ds-cfg-next-workflow-element(required): string
  Defines the next workflow element in the chain of workflow elements.
• ds-cfg-password-attribute: string
  Default Value: userpassword

  Specifies the attribute type used to hold EUS user passwords.
• ds-cfg-server-type: string
  Default Value: local

  Allowed Values: [ "ad", "edir", "local", "odsee", "oid", "oud" ]

  Specifies the type of Directory Server containing the user entries.
• objectclass(required): array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-eus-realm",
        "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 Eus Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.eus.EusWorkflowElement",
            "type":"string"
        },
        "ds-cfg-eus-realm":{
            "description":"Identifies the part of the DIT the EUS workflow element applies to. The value cannot be the null DN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the attribute type used to hold EUS user passwords. ",
            "readOnly":false,
            "default":"userpassword",
            "type":"string"
        },
        "ds-cfg-next-workflow-element":{
            "description":"Defines the next workflow element in the chain of workflow elements. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-server-type":{
            "description":"Specifies the type of Directory Server containing the user entries. ",
            "readOnly":false,
            "default":"local",
            "type":"string",
            "enum":[
                "ad",
                "edir",
                "local",
                "odsee",
                "oid",
                "oud"
            ]
        },
        "ds-cfg-certificate-matching-rule":{
            "description":"Specifies the method used for certificate authentication. ",
            "readOnly":false,
            "default":"certificate-match",
            "type":"string",
            "enum":[
                "certificate-match",
                "certificate-or-dn-match",
                "dn-match",
                "mapper-match",
                "mapper-or-certificate-or-dn-match"
            ]
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

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