REST API for Oracle Unified Directory Administration

Find LDAP Administration Connector by DN

get

/rest/v1/admin/{dn}

Returns an LDAP Administration Connector 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 : LDAP Administration Connector 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/LDAP Administration Connector SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object LDAP Administration Connector SearchResultEntry

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

Nested Schema : LDAP Administration Connector SearchResultEntry

Type: object

Show Source

attributes(required): object LDAP Administration Connector 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/LDAP Administration Connector Properties"
        }
    }
}

Nested Schema : LDAP Administration Connector Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-enabled(required): boolean

Indicates whether the Administration Connector is enabled.
ds-cfg-java-class(required): string

Default Value: org.opends.server.admin.LDAPAdministrationConnector

Specifies the fully-qualified name of the Java class that provides the LDAP Administration Connector implementation.
ds-cfg-key-manager-provider(required): string

Specifies the name of the key manager that is used with the Administration Connector .
ds-cfg-listen-address: array ds-cfg-listen-address

Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients.
ds-cfg-listen-port(required): integer(int32)

Specifies the port number on which the Administration Connector will listen for connections from clients.
ds-cfg-ssl-cert-nickname(required): string

Specifies the nickname (also called the alias) of the certificate that the Administration Connector will use when performing SSL communication.
ds-cfg-ssl-cipher-suite: array ds-cfg-ssl-cipher-suite

Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.
ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol

Specifies the names of the SSL protocols that are allowed for use in SSL communication.
ds-cfg-trust-manager-provider(required): string

Specifies the name of the trust manager that is used with the Administration Connector .
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-trust-manager-provider",
        "ds-cfg-ssl-cert-nickname",
        "ds-cfg-listen-port",
        "ds-cfg-enabled",
        "ds-cfg-key-manager-provider"
    ],
    "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 LDAP Administration Connector implementation. ",
            "readOnly":false,
            "default":"org.opends.server.admin.LDAPAdministrationConnector",
            "type":"string"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the Administration Connector will use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the Administration Connector will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Administration Connector is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that is used with the Administration Connector . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : ds-cfg-listen-address

Type: array

Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients.

Default Value:

[
    "0.0.0.0"
]

Show Source

Array of: string

{
    "description":"Specifies the address or set of addresses on which this Administration Connector should listen for connections from LDAP or HTTP clients. ",
    "readOnly":false,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-ssl-cipher-suite

Type: array

Specifies the names of the SSL cipher suites that are allowed for use in SSL communication.

Show Source

Array of: string

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ds-cfg-ssl-protocol

Type: array

Specifies the names of the SSL protocols that are allowed for use in SSL communication.

Show Source

Array of: string

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL communication. ",
    "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."
        }
    }
}