REST API for Oracle Unified Directory Administration

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

Copy{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "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/Structural Object Class Virtual Attribute SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

• Array of: object Structural Object Class Virtual Attribute SearchResultEntry

Copy{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Structural Object Class Virtual Attribute SearchResultEntry"
    }
}

• attributes(required): object Structural Object Class Virtual Attribute Properties
• dn(required): string
  LDAP DN of the entry to be created

Copy{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Structural Object Class Virtual Attribute Properties"
        }
    }
}

• cn: string
  CN (common name) of the entry
• ds-cfg-attribute-type(required): string
  Default Value: structuralObjectClass

  Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
• ds-cfg-base-dn: array ds-cfg-base-dn

  Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

• ds-cfg-conflict-behavior: string
  Default Value: virtual-overrides-real

  Allowed Values: [ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]

  Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.
• ds-cfg-enabled(required): boolean
  Indicates whether the Virtual Attribute is enabled for use.
• ds-cfg-filter: array ds-cfg-filter

  Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

• ds-cfg-group-dn: array ds-cfg-group-dn

  Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

• ds-cfg-java-class(required): string
  Default Value: org.opends.server.extensions.StructuralObjectClassVirtualAttributeProvider

  Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-attribute-type",
        "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-filter":{
            "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
            "readOnly":false,
            "default":[
                "(objectClass=*)"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.StructuralObjectClassVirtualAttributeProvider",
            "type":"string"
        },
        "ds-cfg-conflict-behavior":{
            "description":"Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. ",
            "readOnly":false,
            "default":"virtual-overrides-real",
            "type":"string",
            "enum":[
                "merge-real-and-virtual",
                "real-overrides-virtual",
                "virtual-overrides-real"
            ]
        },
        "ds-cfg-group-dn":{
            "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute-type":{
            "description":"Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute. ",
            "readOnly":false,
            "default":"structuralObjectClass",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Virtual Attribute is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

• Array of: string

Copy{
    "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
    "readOnly":false,
    "default":[
        "(objectClass=*)"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

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

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

Copy{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Structural Object Class Virtual Attribute SearchResultEntry"
            }
        }
    }
}

• Array of: object Structural Object Class Virtual Attribute SearchResultEntry

Copy{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Structural Object Class Virtual Attribute SearchResultEntry"
    }
}

• attributes(required): object Structural Object Class Virtual Attribute Properties
• dn(required): string
  LDAP DN of the entry to be created

Copy{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Structural Object Class Virtual Attribute Properties"
        }
    }
}

• cn: string
  CN (common name) of the entry
• ds-cfg-attribute-type(required): string
  Default Value: structuralObjectClass

  Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute.
• ds-cfg-base-dn: array ds-cfg-base-dn

  Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute.

• ds-cfg-conflict-behavior: string
  Default Value: virtual-overrides-real

  Allowed Values: [ "merge-real-and-virtual", "real-overrides-virtual", "virtual-overrides-real" ]

  Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute.
• ds-cfg-enabled(required): boolean
  Indicates whether the Virtual Attribute is enabled for use.
• ds-cfg-filter: array ds-cfg-filter

  Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries.

• ds-cfg-group-dn: array ds-cfg-group-dn

  Specifies the DNs of the groups whose members can be eligible to use this virtual attribute.

• ds-cfg-java-class(required): string
  Default Value: org.opends.server.extensions.StructuralObjectClassVirtualAttributeProvider

  Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values.
• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-attribute-type",
        "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-filter":{
            "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
            "readOnly":false,
            "default":[
                "(objectClass=*)"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the virtual attribute provider class that generates the attribute values. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.StructuralObjectClassVirtualAttributeProvider",
            "type":"string"
        },
        "ds-cfg-conflict-behavior":{
            "description":"Specifies the behavior that the server is to exhibit for entries that already contain one or more real values for the associated attribute. ",
            "readOnly":false,
            "default":"virtual-overrides-real",
            "type":"string",
            "enum":[
                "merge-real-and-virtual",
                "real-overrides-virtual",
                "virtual-overrides-real"
            ]
        },
        "ds-cfg-group-dn":{
            "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-attribute-type":{
            "description":"Specifies the attribute type for the attribute whose values are to be dynamically assigned by the virtual attribute. ",
            "readOnly":false,
            "default":"structuralObjectClass",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Virtual Attribute is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

• Array of: string

Copy{
    "description":"Specifies the base DNs for the branches containing entries that are eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the search filters to be applied against entries to determine if the virtual attribute is to be generated for those entries. ",
    "readOnly":false,
    "default":[
        "(objectClass=*)"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "description":"Specifies the DNs of the groups whose members can be eligible to use this virtual attribute. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

• Array of: string

Copy{
    "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

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