Oracle Target Connector External API Configuration
capam344
This topic describes the required and supported Attributes used when adding or updating an Oracle Target Application using the External API.
2
Oracle Target Application External API Attributes
To add or update an Oracle Target application using the External API, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
sslCertServerDN
The Distinguished Name (DN) of the Oracle Server.
Required | Default Value | Valid Value |
no | None | string |
extensionType
The target application extension type.
Required | Default Value | Valid Value |
yes | None | oracle |
port
The port that is used to connect to an Oracle Database server.
Required | Default Value | Valid Value |
yes | None | 0-65535 |
oidport (Oracle Internet Directory)
The port that is used to connect to an Oracle Internet Directory (LDAP) server. Do not specify for Oracle Database.
Required | Default Value | Valid Value |
yes | None | 0-65535 |
sslEnabled
Specifies whether SSL is enabled.
Required | Default Value | Valid Values |
yes | None | true, false |
sslCertificate
The SSL certificate.
Required | Default Value | Valid Value |
Required if the protocol is SSL | None | X.509 digital certificate in BASE64 encoded format |
Oracle Target Account External API Attributes
To add a xxx target account that uses the target connector, use the following properties as members of the "attributes" associative array included in the 'body' parameter of the REST call:
schema (Oracle Database)
The name of the database schema to which the account belongs. Do not specify this option for Oracle Internet Directory.
Required | Default Value | Valid Value |
yes (for Oracle database) | None | string |
useOtherAccountToChangePassword
Specifies whether to use the target account or a different account to perform password change requests.
Required | Default Value | Valid Values |
yes | None | true, false |
otherAccount
Specifies which other account to use to perform password change requests.
Required | Default Value | Valid Value |
yes, if useOtherAccountToChangePassword is true | None | A valid target account ID |
useOid (Oracle Database)
Specifies the connection type in use. Do not specify this option for Oracle Internet Directory.
Required | Default Value | Valid Values |
yes | false | true, false |
sid (Oracle Internet Directory)
Specifies the System Identifier (SID) of the Oracle Internet Directory database instance. Do not specify this option for Oracle Database.
Required | Default Value | Valid Value |
yes (for Oracle Internet Directory) | None | A valid SID (as specified during Oracle database installation). Example: orcl |
cn (Oracle Internet Directory)
Specifies the Common Name (CN) for an Oracle Context. Do not specify this option for Oracle Database.
Required | Default Value | Valid Value |
yes | cn=OracleContext | A valid CN |
racService
Specifies whether the schema is a RAC service name.
Required | Default Value | Valid Values |
yes | None | true, false |
sysdbaAccount
Specifies whether this user must authenticate as the
Sysdba
role.Required | Default Value | Valid Values |
yes | None | true, false |
replaceSyntax
Specifies whether the
REPLACE
syntax must be used for changing the password that is associated with otheraccounts
.Required | Default Value | Valid Values |
yes | None | true, false |
Oracle Target Application External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName": "OracleApp", "applicationType": "oracle", "description1": "sample descriptor1", "description2": "sample descriptor2", "attributes": { "sslCertificate": "-----BEGIN CERTIFICATE-----atNlKIQ9DYYVvJMkmUgaq5HiALrRH/qZut58K64vOgl7r5O0SS5jT1RwwKDq -----END CERTIFICATE-----", "port": "2484", "extensionType": "oracle", "sslEnabled": "true", "oidPort": "3060" }, "passwordCompositionPolicyId": null }
Oracle Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"oracleAcc", "attributes": { "schema": "schema1", "discoveryAllowed": "f", "sysdbaAccount": "false", "useOid": "false", "cn": "", "sid": "", "racService": "false", "otherAccount": "", "descriptor2": "", "discoveryGlobal": "false", "descriptor1": "", "replaceSyntax": "false", "useOtherAccountToChangePassword": "false" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }