Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Format

MethodPOST
URL

/tasks/create

Request contentTerminalPolicyModify Object
Successful answerTaskResult Object
Unexpected errorHTTP 500

TerminalPolicyModify Object

Schema

repeatStringReserved
retriesStringNumber of times this task will be retried, in case of error
typeStringTask type identifier. In this case, "tpolicy_modify"
terminal_policy_idStringUnique identifier of the Terminal Policy to modify
auth_modeStringAuthentication mode. Currently, one of "none" or "active_directory"
ad_server_ipStringIP address of the LDAP/AD server that authenticates users
ad_server_portStringTCP port of the LDAP/AD server
ad_proxy_userStringLDAP/AD user with search permission
ad_proxy_passStringLDAP/AD proxy user's password
ad_realmStringBase DN to look for users
ad_rdn_attrStringLDAP attribute to identify users (e.g. cn, uid, sAMAccountName, ...)
desktop_policy_attrStringLDAP attribute that contains the list of desktop policies for each user. Can be empty.
desktop_policy_group_attrStringSince 3.0.3: LDAP attribute that contains the list of desktop policies for each group the user is member of. Can be empty, in which case groups are not looked for Desktop Policies
desktop_policy_defaultStringList of desktop policies to use when desktop_policy_attr is empty or does not exist. Can be empty too.

JSON example

{
    "repeat": "0",
    "retries": "0",
    "type": "tpolicy_modify",
    "ad_rdn_attr": "cn",
    "auth_mode": "active_directory",
    "terminal_policy_id": "default",
    "ad_proxy_pass": "password",
    "ad_server_ip": "10.111.8.12",
    "desktop_policy_attr": "description",
    "desktop_policy_group_attr": "info",
    "desktop_policy_default": "windows7_public=Windows 7,opensuse421_public=OpenSUSE 42.1",
    "ad_server_port": "389",
    "ad_proxy_user": "cn=Administrator,cn=Users,dc=flexvdi,dc=demo",
    "ad_realm": "cn=Users,dc=flexvdi,dc=demo"
}
  • No labels