IBM i Target Connector External API Configuration

capam344
This topic describes the required and supported Attributes used when adding or updating an IBM i (AS400) Target Application using the External API:
2
IBM i Target Application External API Attributes
To add or update an IBM i (aka AS 400) 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:
sslEnabled
Specify whether to use a secure (SSL or TLS) connection.
Required
Default Value
Valid Values
yes
true
true
,
false
IBM i Target Account External API Attributes
To add an IBM i (aka As 400) 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:
useOtherAccountToChangePassword
Specify whether to use the target account or a different account to perform password change requests.
Required
Default Value
Valid Values
yes
N/A
true
,
false
otherAccount
Specify which other account to use to perform password change requests.
Required
Default Value
Valid Values
If
useOtherAccountToChangePassword
is true, set this parameter to yes
N/A
A valid target account ID
IBM i Target Application External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName": "AS400", "applicationType": "AS400", "description1": "sample descriptor1", "description2": "sample descriptor2", "attributes": { "sslEnabled": "false" }, "passwordCompositionPolicyId": null }
IBM i Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"AS400Acc", "attributes": { "otherAccount": "", "descriptor2": "", "discoveryGlobal": "f", "descriptor1": "", "discoveryAllowed": "f", "useOtherAccountToChangePassword": "false", "unlockLockedAccount": "f" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }
"useOtherAccountToChangePassword": "false" false/true values only