REST API for Oracle Unified Directory Administration

Find Hide Entries By Filter Workflow Element by DN

get

/rest/v1/admin/{dn}

Returns an Hide Entries By Filter Workflow Element by DN

Request

Supported Media Types

application/json

Path Parameters

dn(required): string

LDAP DN of the entry to be fetched.

Query Parameters

attributes: array[string]

Collection Format: multi

List of attributes to be fetched for the entry.
controls: array[string]

Collection Format: multi

LDAP controls to be sent to server for search operation.
filter: string

Search filter for the LDAP search operation. Should follow LDAP search filter syntax.
scope: string

Scope for the LDAP search operation.

Allowed Values: [ "base", "sub", "one" ]

Response

Supported Media Types

application/json

200 Response

Root Schema : Hide Entries By Filter Workflow Element GetSuccessResponse

Type: object

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/Hide Entries By Filter Workflow Element SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Hide Entries By Filter Workflow Element SearchResultEntry

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

Nested Schema : Hide Entries By Filter Workflow Element SearchResultEntry

Type: object

Show Source

attributes(required): object Hide Entries By Filter 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/Hide Entries By Filter Workflow Element Properties"
        }
    }
}

Nested Schema : Hide Entries By Filter Workflow Element Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-apply-for-admin(required): boolean

Default Value: false

Control whether the filtering is applicable to root users. If this parameter is set to false, and the bound user is a root user, the search results are returned as is, without being further filtered by the workflow element.
ds-cfg-enabled(required): boolean

Indicates whether the Workflow Element is enabled for use in the server.
ds-cfg-excluded-ldap-url: array ds-cfg-excluded-ldap-url

Specifies a list of the LDAP URL used for the excluded filtering.
ds-cfg-java-class(required): string

Default Value: org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement

Specifies the fully-qualified name of the Java class that provides the Hide Entries By Filter Workflow Element implementation.
ds-cfg-ldap-filter: string

Specifies the LDAP filter used for the filtering.
ds-cfg-ldap-url: array ds-cfg-ldap-url

Specifies a list of the LDAP URL used for the filtering.
ds-cfg-next-workflow-element(required): string

Defines the next workflow element in the chain of workflow elements.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-apply-for-admin",
        "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 Hide Entries By Filter Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.ovdplugin.hideentriesbyfilter.HideEntriesByFilterWorkflowElement",
            "type":"string"
        },
        "ds-cfg-ldap-filter":{
            "description":"Specifies the LDAP filter used for the filtering. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-excluded-ldap-url":{
            "description":"Specifies a list of the LDAP URL used for the excluded filtering. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-apply-for-admin":{
            "description":"Control whether the filtering is applicable to root users. If this parameter is set to false, and the bound user is a root user, the search results are returned as is, without being further filtered by the workflow element. ",
            "readOnly":false,
            "default":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-ldap-url":{
            "description":"Specifies a list of the LDAP URL used for the filtering. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        }
    }
}

Nested Schema : ds-cfg-excluded-ldap-url

Type: array

Specifies a list of the LDAP URL used for the excluded filtering.

Show Source

Array of: string

{
    "description":"Specifies a list of the LDAP URL used for the excluded filtering. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-ldap-url

Type: array

Specifies a list of the LDAP URL used for the filtering.

Show Source

Array of: string

{
    "description":"Specifies a list of the LDAP URL used for the filtering. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectclass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

Array of: string

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

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

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