REST API for Oracle Unified Directory Administration

Find Crypto Manager by DN

get

/rest/v1/admin/{dn}

Returns an Crypto Manager 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 : Crypto Manager 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/Crypto Manager SearchResultEntry"
            }
        }
    }
}

Nested Schema : searchResultEntries

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object Crypto Manager SearchResultEntry

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

Nested Schema : Crypto Manager SearchResultEntry

Type: object

Show Source

attributes(required): object Crypto Manager 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/Crypto Manager Properties"
        }
    }
}

Nested Schema : Crypto Manager Properties

Type: object

Show Source

cn: string

CN (common name) of the entry
ds-cfg-cipher-key-length: integer(int32)

Default Value: 128

Specifies the key length in bits for the preferred cipher.
ds-cfg-cipher-transformation: string

Default Value: AES/CBC/PKCS5Padding

Specifies the cipher for the Directory Server using the syntax algorithm/mode/padding.
ds-cfg-digest-algorithm: string

Default Value: SHA-1

Specifies the preferred message digest algorithm for the Directory Server.
ds-cfg-key-wrapping-transformation: string

Default Value: RSA/ECB/OAEPWITHSHA-1ANDMGF1PADDING

The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology.
ds-cfg-mac-algorithm: string

Default Value: HmacSHA1

Specifies the preferred MAC algorithm for the Directory Server.
ds-cfg-mac-key-length: integer(int32)

Default Value: 128

Specifies the key length in bits for the preferred MAC algorithm.
ds-cfg-password-storage-scheme: string

Default Value: AES

Specifies the password storage scheme that is used to encode passwords for various components.
ds-cfg-ssl-cert-nickname: string

Specifies the nickname (also called the alias) of the certificate that the Crypto Manager should 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 or TLS communication.
ds-cfg-ssl-encryption: boolean

Default Value: false

Specifies whether SSL/TLS is used to provide encrypted communication between two Oracle Unified Directory server components.
ds-cfg-ssl-protocol: array ds-cfg-ssl-protocol

Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication.
objectclass(required): array objectclass

Objectclass(es) which this entry belongs to.

{
    "type":"object",
    "required":[
        "objectclass"
    ],
    "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-password-storage-scheme":{
            "description":"Specifies the password storage scheme that is used to encode passwords for various components. ",
            "readOnly":false,
            "default":"AES",
            "type":"string"
        },
        "ds-cfg-key-wrapping-transformation":{
            "description":"The preferred key wrapping transformation for the Directory Server. This value must be the same for all server instances in a replication topology. ",
            "readOnly":false,
            "default":"RSA/ECB/OAEPWITHSHA-1ANDMGF1PADDING",
            "type":"string"
        },
        "ds-cfg-cipher-key-length":{
            "description":"Specifies the key length in bits for the preferred cipher. ",
            "readOnly":false,
            "default":"128",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-mac-key-length":{
            "description":"Specifies the key length in bits for the preferred MAC algorithm. ",
            "readOnly":false,
            "default":"128",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-mac-algorithm":{
            "description":"Specifies the preferred MAC algorithm for the Directory Server. ",
            "readOnly":false,
            "default":"HmacSHA1",
            "type":"string"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS 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 Crypto Manager should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-digest-algorithm":{
            "description":"Specifies the preferred message digest algorithm for the Directory Server. ",
            "readOnly":false,
            "default":"SHA-1",
            "type":"string"
        },
        "ds-cfg-cipher-transformation":{
            "description":"Specifies the cipher for the Directory Server using the syntax algorithm/mode/padding. ",
            "readOnly":false,
            "default":"AES/CBC/PKCS5Padding",
            "type":"string"
        },
        "ds-cfg-ssl-encryption":{
            "description":"Specifies whether SSL/TLS is used to provide encrypted communication between two Oracle Unified Directory server components. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or TLS communication. ",
            "readOnly":false,
            "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 or TLS communication.

Show Source

Array of: string

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or TLS 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 or TLS communication.

Show Source

Array of: string

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