Desktop Configuration API Parameters
Parameter |
Type |
Description |
Possible Values |
Notes |
---|---|---|---|---|
deploymentType |
String |
The type of deployment for Cisco Finesse. |
UCCE, UCCX |
— |
securityBannerMessage |
String |
The message to be displayed in the security banner. |
— |
— |
systemStatus |
Integer |
The state of the Cisco Finesse system. |
IN_SERVICE: The system is in service and normal operations are accepted. OUT_OF_SERVICE: The system is out of service and normal operations result in a 503 Service Unavailable response. |
— |
host |
String |
The hostname or IP address of the primary Finesse server. |
— |
No special characters allowed except period "." and minus "-". |
isAlternateSystemAvailable |
Boolean |
Indicates the availability of Finesse secondary node. |
true or false |
— |
desktopLicensed |
String |
The Unified CCX license. |
STANDARD, ENHANCED, or PREMIUM |
This parameter is blank for Unified CCE deployments. |
systemAuthMode |
String |
Information about the system authentication mode. |
SSO or non-SSO |
Hybrid is for Unified CCE deployment. |
enableMobileAgentLogin |
Boolean |
Indicates the status of Sign in as a Mobile Agent feature on the Finesse sign in page. |
true or false |
Applicable only to Unified CCE deployments |
isProxyRequest |
Boolean |
Indicates whether request is made via proxy. |
true or false |
— |
redirectToAlternateHost |
Boolean |
Indicates whether the requests are redirected to alternate host. |
true or false |
— |
alternateHost |
String |
The hostname or IP address of the secondary Finesse node. |
— |
— |