REST API for Oracle Unified Directory Administration

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

Copy{
    "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/RDBMS Extension SearchResultEntry"
            }
        }
    }
}

• Array of: object RDBMS Extension SearchResultEntry

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

• attributes(required): object RDBMS Extension 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/RDBMS Extension Properties"
        }
    }
}

• cn: string
  CN (common name) of the entry
• ds-cfg-connection-pool-provider: string
  Default Value: universal-connection-pool

  Allowed Values: [ "simple-pool", "universal-connection-pool" ]

  The connection pool implementation to use for this extension. By default we use Universal Connection Pool (UCP). NOTE: In case Simple_Pool is used then the RDBMS Extension cannot be shared across multiple RDBMS WorkflowElements.
• ds-cfg-connection-reuse-count: integer(int32)
  Default Value: 0

  Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled.
• ds-cfg-enabled(required): boolean
  Indicates whether the Extension is enabled.
• ds-cfg-inactive-connection-timeout: integer(int32)
  Default Value: 0

  Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool. The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0. Setting the value to 0 disables inactive connection timeout processing.
• ds-cfg-initial-connection-pool-size: integer(int32)
  Default Value: 0

  The initial number of connections setup by the ConnectionPool. This is the number of connections that will be created and placed in the pool when the pool is started. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0.
• ds-cfg-java-class(required): string
  Default Value: com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension

  Specifies the fully-qualified name of the Java class that provides the RDBMS Extension implementation.
• ds-cfg-jdbc-connection-properties: array ds-cfg-jdbc-connection-properties

  Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties.

• ds-cfg-jdbc-driver-class(required): string
  Specifies the fully-qualified name of the Java class that provides the JDBC driver implementation for the RDBMS vendor.
• ds-cfg-jdbc-factory-properties: boolean
  Default Value: false

  Optional flag to specify if JDBC driver related connection properties need to be set as connection factory properties.
• ds-cfg-jdbc-keystore-prop-name: string
  Default Value: javax.net.ssl.keyStore

  KeyStore property name for the JDBC driver.
• ds-cfg-jdbc-keystore-pwd-prop-name: string
  Default Value: javax.net.ssl.keyStorePassword

  KeyStore password property name for the JDBC driver.
• ds-cfg-jdbc-keystore-type-prop-name: string
  Default Value: javax.net.ssl.keyStoreType

  KeyStore type property name for the JDBC driver.
• ds-cfg-jdbc-truststore-prop-name: string
  Default Value: javax.net.ssl.trustStore

  TrustStore property name for the JDBC driver.
• ds-cfg-jdbc-truststore-pwd-prop-name: string
  Default Value: javax.net.ssl.trustStorePassword

  TrustStore password property name for the JDBC driver.
• ds-cfg-jdbc-truststore-type-prop-name: string
  Default Value: javax.net.ssl.trustStoreType

  TrustStore type property name for the JDBC driver.
• ds-cfg-jdbc-url(required): string
  JDBC URL for connecting to the database.
• ds-cfg-login-timeout: integer(int32)
  Default Value: 0

  Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.
• ds-cfg-maximum-connection-pool-size: integer(int32)
  Default Value: 20

  The maximum number of connections that can be setup by the connection pool. The maximum number of connections includes the number of connections that are in use as well as the number of available connections. The range of valid values is 1 to Integer.MAX_VALUE. Defaults to 20.
• ds-cfg-minimum-connection-pool-size: integer(int32)
  Default Value: 10

  Sets the minimum number of connections set up by the connection pool. If the number of available connections + the number of connections in use is less than the minimum then the connection is returned to the pool. Otherwise, the connection is closed. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 10.
• ds-cfg-rdbms-password: string
  Default Value:

  The password with which connections have to be obtained.
• ds-cfg-rdbms-username(required): string
  The user name with which connections have to be obtained.
• ds-cfg-ssl-key-manager-provider: string
  Specifies key manager provider to use with RDBMS Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication.
• ds-cfg-ssl-trust-manager-provider: string
  Specifies trust manager provider to use with RDBMS Extension. This trust manager provider is mandatory when secure connection needs to be established with the remote backend.
• ds-cfg-target-database: string
  Allowed Values: [ "db2", "db2mainframe", "derby", "mysql", "mysql4", "oracle", "oracle10g", "oracle11", "oracle8i", "oracle9i", "postgresql", "sqlserver", "timesten" ]

  Specify the Target Database in the backend.
• ds-cfg-use-ssl: boolean
  Default Value: false

  Specifies to use secure JDBC connection to the database.
• objectclass(required): array objectclass

  Objectclass(es) which this entry belongs to.

Copy{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-jdbc-driver-class",
        "ds-cfg-rdbms-username",
        "ds-cfg-jdbc-url"
    ],
    "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 RDBMS Extension implementation. ",
            "readOnly":false,
            "default":"com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension",
            "type":"string"
        },
        "ds-cfg-jdbc-factory-properties":{
            "description":"Optional flag to specify if JDBC driver related connection properties need to be set as connection factory properties. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-jdbc-keystore-pwd-prop-name":{
            "description":"KeyStore password property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.keyStorePassword",
            "type":"string"
        },
        "ds-cfg-target-database":{
            "description":"Specify the Target Database in the backend. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "db2",
                "db2mainframe",
                "derby",
                "mysql",
                "mysql4",
                "oracle",
                "oracle10g",
                "oracle11",
                "oracle8i",
                "oracle9i",
                "postgresql",
                "sqlserver",
                "timesten"
            ]
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Extension is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-connection-reuse-count":{
            "description":"Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-rdbms-password":{
            "description":"The password with which connections have to be obtained. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-ssl-key-manager-provider":{
            "description":"Specifies key manager provider to use with RDBMS Extension. This key manager provider is not mandatory and may be used if the remote server is configured for client authentication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-maximum-connection-pool-size":{
            "description":"The maximum number of connections that can be setup by the connection pool. The maximum number of connections includes the number of connections that are in use as well as the number of available connections. The range of valid values is 1 to Integer.MAX_VALUE. Defaults to 20. ",
            "readOnly":false,
            "default":"20",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Specifies to use secure JDBC connection to the database. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-jdbc-keystore-prop-name":{
            "description":"KeyStore property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.keyStore",
            "type":"string"
        },
        "ds-cfg-login-timeout":{
            "description":"Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-jdbc-connection-properties":{
            "description":"Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-trust-manager-provider":{
            "description":"Specifies trust manager provider to use with RDBMS Extension. This trust manager provider is mandatory when secure connection needs to be established with the remote backend. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-jdbc-truststore-type-prop-name":{
            "description":"TrustStore type property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.trustStoreType",
            "type":"string"
        },
        "ds-cfg-jdbc-keystore-type-prop-name":{
            "description":"KeyStore type property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.keyStoreType",
            "type":"string"
        },
        "ds-cfg-jdbc-driver-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the JDBC driver implementation for the RDBMS vendor. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-connection-pool-provider":{
            "description":"The connection pool implementation to use for this extension. By default we use Universal Connection Pool (UCP). NOTE: In case Simple_Pool is used then the RDBMS Extension cannot be shared across multiple RDBMS WorkflowElements. ",
            "readOnly":false,
            "default":"universal-connection-pool",
            "type":"string",
            "enum":[
                "simple-pool",
                "universal-connection-pool"
            ]
        },
        "ds-cfg-rdbms-username":{
            "description":"The user name with which connections have to be obtained. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-jdbc-url":{
            "description":"JDBC URL for connecting to the database. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-jdbc-truststore-prop-name":{
            "description":"TrustStore property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.trustStore",
            "type":"string"
        },
        "ds-cfg-minimum-connection-pool-size":{
            "description":"Sets the minimum number of connections set up by the connection pool. If the number of available connections + the number of connections in use is less than the minimum then the connection is returned to the pool. Otherwise, the connection is closed. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 10. ",
            "readOnly":false,
            "default":"10",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-inactive-connection-timeout":{
            "description":"Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool. The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0. Setting the value to 0 disables inactive connection timeout processing. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-jdbc-truststore-pwd-prop-name":{
            "description":"TrustStore password property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.trustStorePassword",
            "type":"string"
        },
        "ds-cfg-initial-connection-pool-size":{
            "description":"The initial number of connections setup by the ConnectionPool. This is the number of connections that will be created and placed in the pool when the pool is started. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        }
    }
}

• Array of: string

Copy{
    "description":"Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties. ",
    "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."
        }
    }
}