gac_settings.md

page_title	subcategory	description
citrix_gac_settings Resource - citrix	Citrix Cloud	Manages the Global App Configuration settings for a service url.

citrix_gac_settings (Resource)

Manages the Global App Configuration settings for a service url.

Global App Configuration

The Global App Configuration (GAC) Service is designed to allow administrators to easily configure:

• The workspace service URL to the email domain for discovery
• Settings for Citrix Workspace apps

At this time, the citrix terraform provider only supports GAC settings configuration for Citrix Workspace apps.

Reference Links:

• Prerequisites to use Global App Configuration Service
• GAC Supported settings and their values per platform - Please note that only settings objects with value type of integer, boolean, strings and list of strings is currently supported by the citrix terraform provider.
• Global App Configuration Service for StoreFront stores

Example Usage

resource "citrix_gac_settings" "test_settings_configuration" {
    service_url = "https://<your_service_url>:443"
    name = "test-settings"
    description = "Test settings configuration"
    app_settings = {
        windows = [
            {
                user_override = false,
                category = "ica client",
                settings = [
                    {
                        name = "Allow Client Clipboard Redirection",
                        value_string = "true"
                    }
                ]
            },
            {
                user_override = false,
                category = "browser",
                settings = [
                    {
                        name = "delete browsing data on exit",
                        value_list = [
                            "browsing_history",
                            "download_history"
                        ]
                    },
                    {
                        name = "relaunch notification period",
                        value_string = "3600000"
                    }
                ]
            },
            {
                user_override = false,
                category = "dazzle",
                settings = [
                    {
                        name = "Local App Whitelist",
                        local_app_allow_list = [
                            {
                                arguments = "www.citrix.com",
                                name = "Google Chrome",
                                path = "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe"
                            },
                            {
                                arguments = "www.citrix2.com",
                                name = "Google Chrome2",
                                path = "C:\\Program Files (x86)\\Google\\Chrome\\Application\\chrome.exe"
                            },
                        ]
                    }
                ]
            },
        ],
        html5 = [
            {
                category = "virtual channel",
                user_override = false,
                settings = [
                    {
                        name = "Clipboard Operations Between VDA And Local Device",
                        value_string = "true"
                    }  
                ]
            }
        ],
        ios = [
            {
                category = "audio",
                user_override = false,
                settings = [
                    {
                        name = "audio",
                        value_string = "true"
                    }  
                ]
            }
        ],
        macos = [
            {
                category = "ica client",
                user_override = false,
                settings = [
                    {
                        name = "Reconnect Apps and Desktops",
                        value_list = [
                            "startWorkspace",
                            "refreshApps"
                        ]
                    }
                ]
            },
             {
                user_override = false,
                category = "browser",
                settings = [
                    {
                        name = "managed bookmarks",
                        managed_bookmarks = [
                            {
                                name = "Citrix",
                                url = "https://www.citrix.com/"
                            },
                            {
                                name = "Citrix Workspace app",
                                url = "https://www.citrix.com/products/receiver.html"
                            }
                        ]
                    }
                ]
            }
        ],
        linux = [
            {
                category = "root",
                user_override = false,
                settings = [
                    {
                        name = "enable fido2",
                        value_string = "true"
                    }
                ]
            }
        ]
        ,
        android = [
        {
            category      = "keyboard",
            user_override = false,
            settings = [
            {
                name         = "enable client ime",
                value_string = "true"
            }
            ]
        }
        ]
    }
}

Schema

Required

• app_settings (Attributes) Defines the device platform and the associated settings. Currently, only settings objects with value type of integer, boolean, strings and list of strings is supported. (see below for nested schema)
• description (String) Description of the settings record.
• name (String) Name of the settings record.
• service_url (String) Citrix workspace application store url for which settings are to be configured. The value is case sensitive and requires the protocol ("https" or "http") and port number.

Optional

• test_channel (Boolean) Defines whether to use the test channel for settings or not. Defaults to false.
• use_for_app_config (Boolean) Defines whether to use the settings for app configuration or not. Defaults to true.

Nested Schema for app_settings

Optional:

• android (Attributes Set) Settings to be applied for users using android platform. (see below for nested schema)
• chromeos (Attributes Set) Settings to be applied for users using chrome os platform. (see below for nested schema)
• html5 (Attributes Set) Settings to be applied for users using html5. (see below for nested schema)
• ios (Attributes Set) Settings to be applied for users using ios platform. (see below for nested schema)
• linux (Attributes Set) Settings to be applied for users using linux platform. (see below for nested schema)
• macos (Attributes Set) Settings to be applied for users using mac os platform. (see below for nested schema)
• windows (Attributes Set) Settings to be applied for users using windows platform. (see below for nested schema)

Nested Schema for app_settings.android

Required:

• category (String) Defines the category of the setting.
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to the following table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.android.settings

Required:

• name (String) Name of the setting.

Optional:

• value_list (List of String) List value (if any) associated with the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.chromeos

Required:

• category (String) Defines the category of the setting.
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to the following table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.chromeos.settings

Required:

• name (String) Name of the setting.

Optional:

• value_list (List of String) List value (if any) associated with the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.html5

Required:

• category (String) Defines the category of the setting.
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to the following table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.html5.settings

Required:

• name (String) Name of the setting.

Optional:

• value_list (List of String) List value (if any) associated with the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.ios

Required:

• category (String) Defines the category of the setting
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to the following table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.ios.settings

Required:

• name (String) Name of the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.linux

Required:

• category (String) Defines the category of the setting.
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to the following table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.linux.settings

Required:

• name (String) Name of the setting.

Optional:

• auto_launch_protocols_from_origins (Attributes Set) A set of protocols that can launch an external application from the listed origins without prompting the user. (see below for nested schema)
• extension_install_allow_list (Attributes Set) An allowed list of extensions that users can add to the Citrix Enterprise Browser. This list uses the Chrome Web Store. (see below for nested schema)
• managed_bookmarks (Attributes Set) A set of bookmarks to push to the Citrix Enterprise Browser. (see below for nested schema)
• value_list (List of String) List value (if any) associated with the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.linux.settings.value_string

Required:

• protocol (String) Auto launch protocol

Optional:

• allowed_origins (List of String) List of origins urls

Nested Schema for app_settings.linux.settings.value_string

Required:

• id (String) Id of the allowed extensions.
• install_link (String) Install link for the allowed extensions.
• name (String) Name of the allowed extensions.

Nested Schema for app_settings.linux.settings.value_string

Required:

• name (String) Name for the bookmark
• url (String) URL for the bookmark

Nested Schema for app_settings.macos

Required:

• category (String) Defines the category of the setting.
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to the following table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.macos.settings

Required:

• name (String) Name of the setting.

Optional:

• auto_launch_protocols_from_origins (Attributes Set) Specify a list of protocols that can launch an external application from the listed origins without prompting the user. (see below for nested schema)
• enterprise_browser_sso (Attributes) Enables Single Sign-on (SSO) for all the web and SaaS apps for the selected Operating System for the IdP domains added as long as the same IdP is used to sign in to the Citrix Workspace app and the relevant web or SaaS app. (see below for nested schema)
• extension_install_allow_list (Attributes Set) Array of objects of type ExtensionInstallAllowlist. For example: {id:"extension_id1",name:"extension_name1",install link:"chrome store url for the extension"} (see below for nested schema)
• managed_bookmarks (Attributes Set) Array of objects of type ManagedBookmarks. For example: {name:"bookmark_name1",url:"bookmark_url1"} (see below for nested schema)
• value_list (List of String) List value (if any) associated with the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.macos.settings.value_string

Required:

• protocol (String) Auto launch protocol

Optional:

• allowed_origins (List of String) List of origins urls

Nested Schema for app_settings.macos.settings.value_string

Required:

• citrix_enterprise_browser_sso_domains (List of String) List of IdP domains for which SSO is enabled.
• citrix_enterprise_browser_sso_enabled (Boolean) Enables Single Sign-on (SSO) for all the web and SaaS apps.

Nested Schema for app_settings.macos.settings.value_string

Required:

• id (String) Id of the allowed extensions.
• install_link (String) Install link for the allowed extensions.
• name (String) Name of the allowed extensions.

Nested Schema for app_settings.macos.settings.value_string

Required:

• name (String) Name for the bookmark
• url (String) URL for the bookmark

Nested Schema for app_settings.windows

Required:

• category (String) Defines the category of the setting.
• settings (Attributes Set) A set of name value pairs for the settings. Please refer to table for the supported settings name and their values per platform. (see below for nested schema)
• user_override (Boolean) Defines if users can modify or change the value of as obtained settings from the Global App Citrix Workspace configuration service.

Nested Schema for app_settings.windows.settings

Required:

• name (String) Name of the setting.

Optional:

• auto_launch_protocols_from_origins (Attributes Set) A set of protocols that can launch an external application from the listed origins without prompting the user. (see below for nested schema)
• enterprise_browser_sso (Attributes) Enables Single Sign-on (SSO) for all the web and SaaS apps for the selected Operating System for the IdP domains added as long as the same IdP is used to sign in to the Citrix Workspace app and the relevant web or SaaS app. (see below for nested schema)
• extension_install_allow_list (Attributes Set) An allowed list of extensions that users can add to the Citrix Enterprise Browser. This list uses the Chrome Web Store. (see below for nested schema)
• local_app_allow_list (Attributes Set) Set of App Object to allow list for Local App Discovery. (see below for nested schema)
• managed_bookmarks (Attributes Set) A set of bookmarks to push to the Citrix Enterprise Browser. (see below for nested schema)
• value_list (List of String) List value (if any) associated with the setting.
• value_string (String) String value (if any) associated with the setting.

Nested Schema for app_settings.windows.settings.value_string

Required:

• protocol (String) Auto launch protocol

Optional:

• allowed_origins (List of String) List of origins urls

Nested Schema for app_settings.windows.settings.value_string

Required:

• citrix_enterprise_browser_sso_domains (List of String) List of IdP domains for which SSO is enabled.
• citrix_enterprise_browser_sso_enabled (Boolean) Enables Single Sign-on (SSO) for all the web and SaaS apps.

Nested Schema for app_settings.windows.settings.value_string

Required:

• id (String) Id of the allowed extensions.
• install_link (String) Install link for the allowed extensions.
• name (String) Name of the allowed extensions.

Nested Schema for app_settings.windows.settings.value_string

Required:

• arguments (String) Arguments for Local App Discovery.
• name (String) Name for Local App Discovery.
• path (String) Path for Local App Discovery.

Nested Schema for app_settings.windows.settings.value_string

Required:

• name (String) Name for the bookmark
• url (String) URL for the bookmark

Import

Import is supported using the following syntax:

# Global App Configuration settings can be imported by specifying the service url
terraform import citrix_gac_settings.test_gac_settings https://example.com:443