Windows Remote Target Application External API Attributes

Windows Remote Target Application External API Attributes
capam32
This topic describes the required and supported Attributes used when adding or updating Windows Remote target applications using the External API.
2
Windows Remote Target Application External API Attributes
To add or update a Windows Remote 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.
accountType
The type of account being managed.
Required
Default Value
Valid Values
yes
domain
domain, local
domainName
The Windows domain for the managed accounts.
Required
Default Value
Valid Values
Required if
accountType
is set to domain (the default).
none
Domain name (a text string)
domain
The Windows domain for the managed accounts. This attribute exists only for backwards compatibility. We recommend using
domainName
instead.
Required
Default Value
Valid Values
Required if
accountType
is set to domain (the default).
none
Domain name (a text string)
useDNS
Determine the level to which DNS is used.
Required
Default Value
Valid Values
Required if
accountType
is set to domain (the default).
none
  • noDNS
    : DNS is not used
  • retrieveDNS
    : Retrieve the DNS server that the Credential Manager server uses
  • specifiedDNS
    : Use the DNS server that is specified by the
    dnsServer
    attribute
dnsServer
The host names of the DNS servers to use.
Required
Default Value
Valid Values
Required if
useDNS
is set to
specifiedDNS
.
none
Comma separated list of DNS server host names.
specifiedServersList
Provide a comma separated list of domain controllers.
Required
Default Value
Valid Values
Required if
useDNS
is set to
specifiedServers
.
none
Comma separated list of valid domain controllers
adSite
The Active Directory site. This parameter is only used if
useDNS
is set to
retrieveDNS
or
specifiedDNS
. If a value is given, Credential Manager uses the value to narrow the search for domain controllers, using the specified name.
Required
Default Value
Valid Values
no
none
String
Windows Remote CLI Example
{ "applicationName":"myWindowsRemote", "applicationType":"windowsRemoteAgent", "attributes": { "accountType":"domain", "domainName":"testDomain", } }