SPML Target Connector External API Configuration

capam32
This topic describes the required and supported Attributes used when adding or updating a SPML Target Application using the External API.
2
SPML Target Application External API Attributes
To add or update a SPML 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:
extensionType
Required
Default Value
Valid Values
yes
N/A
SPML2
port
The port that is used to connect to the SPML server.
Required
Default Value
Valid Values
yes
N/A
0-65535
path
Path to the SPML service.
Required
Default Value
Valid Values
no
N/A
Text string
protocol
The protocol that is used to connect to the SPML server.
Required
Default Value
Valid Values
no
clear
clear, ssl
sslCertificate
The Active Directory SSL certificate.
Required
Default Value
Valid Values
Require if the protocol is
SSL
.
N/A
X.509 digital certificate in BASE64 encoded format
SPML Target Account External API Attributes
To add a SPML 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:
extensionType
Required
Default Value
Valid Values
yes
N/A
SPML2
useOtherAccountToChangePassword
Specifies 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
Specifies which other account to use to perform password change requests.
Required
Default Value
Valid Values
yes if
useOtherAccountToChangePassword
is true.
N/A
A valid target account ID.
SPML Target Application External API Example
SPML2 Target Application external API example POST /api.php/v1/devices.json/{deviceId}/targetApplications { "applicationName":"SPML2App", "applicationType":"SPML2", "attributes":{ "port":"8080", "protocol":"clear" } }
SPML Target Account External API Example
POST /api.php/v1/devices.json/{deviceId}/targetApplications/{applicationId}/targetAccounts { "accountName":"SPML2Act", "attributes":{ "useOtherAccountToChangePassword":"false", "databaseName":"master" }, "cacheBehavior":"useCacheFirst", "cacheDuration":"30", "password":"sample", "passwordViewPolicyId":1000, "privileged":"t", "synchronize":"f", "useAliasNameParameter":"f" }