• 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/Pass Through Authentication Workflow Element SearchResultEntry"
            }
        }
    }
}

• Array of: object Pass Through Authentication Workflow Element SearchResultEntry

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

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

• cn: string
  CN (common name) of the entry
• ds-cfg-auth-provider-workflow-element(required): string
  Identifies the workflow element that provides the authentication service for the user entry retreived by this Pass Through Authentication Workflow Element.
• ds-cfg-enabled(required): boolean
  Indicates whether the Workflow Element is enabled for use in the server.
• ds-cfg-java-class(required): string
  Default Value: org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement

  Specifies the fully-qualified name of the Java class that provides the Pass Through Authentication Workflow Element implementation.
• ds-cfg-password-attribute: string
  Default Value: userPassword

  Specifies the names of the attribute that contains the password locally.
• ds-cfg-pta-auth-suffix: string
  The real base DN that is exposed by the auth provider workflow element
• ds-cfg-pta-join-rule: string
  The join rule defined between the user provider and auth provider workflow elements. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form auth.[attributeName]=user.[attributeName]. If this parameter is not set, the PTA workflow element considers that the user entry and the authentication entry have the same DN.
• ds-cfg-pta-suffix: string
  The virtual DN that will be exposed by the PTA Workflow Element
• ds-cfg-pta-user-suffix: string
  The real base DN that is exposed by the user provider workflow element
• ds-cfg-save-password-on-successful-bind: boolean
  Default Value: false

  Indicates whether the password should be saved in the user entry when authentication succeeds.
• ds-cfg-user-provider-workflow-element(required): string
  Identifies the workflow element that is responsible for providing the requested user entry.
• objectclass(required): array objectclass
  Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-auth-provider-workflow-element",
        "ds-cfg-enabled",
        "ds-cfg-user-provider-workflow-element"
    ],
    "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 Pass Through Authentication Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement",
            "type":"string"
        },
        "ds-cfg-pta-join-rule":{
            "description":"The join rule defined between the user provider and auth provider workflow elements. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form auth.[attributeName]=user.[attributeName]. If this parameter is not set, the PTA workflow element considers that the user entry and the authentication entry have the same DN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the names of the attribute that contains the password locally. ",
            "readOnly":false,
            "default":"userPassword",
            "type":"string"
        },
        "ds-cfg-save-password-on-successful-bind":{
            "description":"Indicates whether the password should be saved in the user entry when authentication succeeds. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-auth-provider-workflow-element":{
            "description":"Identifies the workflow element that provides the authentication service for the user entry retreived by this Pass Through Authentication Workflow Element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-pta-suffix":{
            "description":"The virtual DN that will be exposed by the PTA Workflow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-pta-auth-suffix":{
            "description":"The real base DN that is exposed by the auth provider workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-pta-user-suffix":{
            "description":"The real base DN that is exposed by the user provider workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-user-provider-workflow-element":{
            "description":"Identifies the workflow element that is responsible for providing the requested user entry. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

• Array of: string

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

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