• 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/Key Manager Provider Key Pin SearchResultEntry"
            }
        }
    }
}

• Array of: object Key Manager Provider Key Pin SearchResultEntry

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

• attributes(required): object Key Manager Provider Key Pin 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/Key Manager Provider Key Pin Properties"
        }
    }
}

• cn: string
  CN (common name) of the entry
• ds-cfg-key-pin: string
  Specifies the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. The server will check if the properties are defined in the following order: Java property, environment variable, file, value. The first defined value will be used .
• ds-cfg-key-pin-environment-variable: string
  Specifies the name of the environment variable that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN .
• ds-cfg-key-pin-file: string
  Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN .
• ds-cfg-key-pin-property: string
  Specifies the name of the Java property that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN .
• ds-cfg-ssl-cert-nickname: string
  Read Only: true

  Specifies the nickname of the certificate this Key Manager Provider Key Pin applies to.
• 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-key-pin":{
            "description":"Specifies the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the key PIN properties is specified, the server will try to access the private key using the key manager provider PIN. The server will check if the properties are defined in the following order: Java property, environment variable, file, value. The first defined value will be used . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-pin-property":{
            "description":"Specifies the name of the Java property that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname of the certificate this Key Manager Provider Key Pin applies to. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-key-pin-environment-variable":{
            "description":"Specifies the name of the environment variable that contains the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-key-pin-file":{
            "description":"Specifies the path to the text file whose only contents should be a single line containing the clear-text PIN needed to access the private key in the key store referenced by the key manager provider. If none of the private key PIN properties is specified, the server will try to access the private key using the key manager provider PIN . ",
            "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."
        }
    }
}