|
Parameter
|
Description
|
Valid Values
|
|
authUser
data type: Array
|
Specifies the list of users who have been granted permission to use the On-Premises Connectors in the group.
|
A comma-separated list of users who have been authorized by the owner of the group. Required; can be empty
|
|
connectorID
data type: String
|
The Connector ID of the On-Premises Connector for which information is returned.
|
The ID for the Connector. Required
|
|
connectorGroup
data type: Object
|
Only present if the given connector is a group connector ID. GroupConnectors allow the user to have failover between multiple On-Premises Connectors.
|
An object of type connector_group_object, with the following parameters:
 connectionTimeout: The amount of time, in seconds, that the connectivity service waits for a connection to be established. Required.
retryDelay: indicates the number of seconds the connectivity service considers the connector disabled. Required.
loadBalancing: Specifies whether to enable load balancing. Optional.
members: Specifies the connector ID of each On-Premises Connector in the group, the sequence in which each On-Premises Connector will be tried, and the weight to be applied to the connector. Required.
For more information, see connectorGroup Object.
|
|
label
|
A descriptive name for the Connector that can be used instead of the Connector ID. When not specified, the system name is used. Optional
|
A string with a maximum length of 255 characters.
If two Connectors in the Group have the same label, the owner's name is appended, for example, Production and Production(SueS).
To delete an existing label, set the value to null.
|
|
owner
data type: String
|
The user name of the owner of the Connector. Optional
|
A user name. If owner is specified, its value must match the current owner of the Connector or Connector Group. Changing the owner of a Connector or Connector Group is not supported.
|
