Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. ForwardingControlProxies
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
zscaler/pulumi-zia

zia.ForwardingControlProxies

Explore with Pulumi AI

zia logo
Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
zscaler/pulumi-zia

    Use the zia_forwarding_control_proxies resource allows the creation and management of ZIA forwarding control Proxies for third-party proxy services integration between Zscaler Internet Access and Zscaler Private Access. This resource can then be associated with a ZIA Forwarding Control Rule.

    Example Usage

    No Certificate

    resource "zia_forwarding_control_proxies" "this" {
  name  = "Proxy01_Terraform"
  description = "Proxy01_Terraform"
  type = "PROXYCHAIN"
  address = "192.168.1.150"
  port = 5000
  insert_xau_header = true
  base64_encode_xau_header = true
}

    With Certificate

    resource "zia_forwarding_control_proxies" "this" {
  name  = "Proxy01_Terraform"
  description = "Proxy01_Terraform"
  type = "PROXYCHAIN"
  address = "192.168.1.150"
  port = 5000
  insert_xau_header = true
  base64_encode_xau_header = true
  cert {
    id = 18492369
  }
}

    Create ForwardingControlProxies Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ForwardingControlProxies(name: string, args?: ForwardingControlProxiesArgs, opts?: CustomResourceOptions);
    @overload
def ForwardingControlProxies(resource_name: str,
                             args: Optional[ForwardingControlProxiesArgs] = None,
                             opts: Optional[ResourceOptions] = None)

@overload
def ForwardingControlProxies(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             address: Optional[str] = None,
                             base64_encode_xau_header: Optional[bool] = None,
                             certs: Optional[Sequence[ForwardingControlProxiesCertArgs]] = None,
                             description: Optional[str] = None,
                             insert_xau_header: Optional[bool] = None,
                             name: Optional[str] = None,
                             port: Optional[int] = None,
                             type: Optional[str] = None)
    func NewForwardingControlProxies(ctx *Context, name string, args *ForwardingControlProxiesArgs, opts ...ResourceOption) (*ForwardingControlProxies, error)
    public ForwardingControlProxies(string name, ForwardingControlProxiesArgs? args = null, CustomResourceOptions? opts = null)
    public ForwardingControlProxies(String name, ForwardingControlProxiesArgs args)
public ForwardingControlProxies(String name, ForwardingControlProxiesArgs args, CustomResourceOptions options)

    type: zia:ForwardingControlProxies
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ForwardingControlProxiesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var forwardingControlProxiesResource = new Zia.ForwardingControlProxies("forwardingControlProxiesResource", new()
{
    Address = "string",
    Base64EncodeXauHeader = false,
    Certs = new[]
    {
        new Zia.Inputs.ForwardingControlProxiesCertArgs
        {
            Id = 0,
        },
    },
    Description = "string",
    InsertXauHeader = false,
    Name = "string",
    Port = 0,
    Type = "string",
});

    example, err := zia.NewForwardingControlProxies(ctx, "forwardingControlProxiesResource", &zia.ForwardingControlProxiesArgs{
	Address:               pulumi.String("string"),
	Base64EncodeXauHeader: pulumi.Bool(false),
	Certs: zia.ForwardingControlProxiesCertArray{
		&zia.ForwardingControlProxiesCertArgs{
			Id: pulumi.Int(0),
		},
	},
	Description:     pulumi.String("string"),
	InsertXauHeader: pulumi.Bool(false),
	Name:            pulumi.String("string"),
	Port:            pulumi.Int(0),
	Type:            pulumi.String("string"),
})

    var forwardingControlProxiesResource = new ForwardingControlProxies("forwardingControlProxiesResource", ForwardingControlProxiesArgs.builder()
    .address("string")
    .base64EncodeXauHeader(false)
    .certs(ForwardingControlProxiesCertArgs.builder()
        .id(0)
        .build())
    .description("string")
    .insertXauHeader(false)
    .name("string")
    .port(0)
    .type("string")
    .build());

    forwarding_control_proxies_resource = zia.ForwardingControlProxies("forwardingControlProxiesResource",
    address="string",
    base64_encode_xau_header=False,
    certs=[{
        "id": 0,
    }],
    description="string",
    insert_xau_header=False,
    name="string",
    port=0,
    type="string")

    const forwardingControlProxiesResource = new zia.ForwardingControlProxies("forwardingControlProxiesResource", {
    address: "string",
    base64EncodeXauHeader: false,
    certs: [{
        id: 0,
    }],
    description: "string",
    insertXauHeader: false,
    name: "string",
    port: 0,
    type: "string",
});

    type: zia:ForwardingControlProxies
properties:
    address: string
    base64EncodeXauHeader: false
    certs:
        - id: 0
    description: string
    insertXauHeader: false
    name: string
    port: 0
    type: string

    ForwardingControlProxies Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ForwardingControlProxies resource accepts the following input properties:

    Address string
    The IP address or the FQDN of the third-party proxy service
    Base64EncodeXauHeader bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    Certs List<zscaler.PulumiPackage.Zia.Inputs.ForwardingControlProxiesCert>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    Description string
    (String) Additional notes or information
    InsertXauHeader bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    Name string
    Proxy name for the third-party proxy services
    Port int
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    Type string
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    Address string
    The IP address or the FQDN of the third-party proxy service
    Base64EncodeXauHeader bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    Certs []ForwardingControlProxiesCertArgs
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    Description string
    (String) Additional notes or information
    InsertXauHeader bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    Name string
    Proxy name for the third-party proxy services
    Port int
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    Type string
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address String
    The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader Boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs List<ForwardingControlProxiesCert>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description String
    (String) Additional notes or information
    insertXauHeader Boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name String
    Proxy name for the third-party proxy services
    port Integer
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type String
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address string
    The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs ForwardingControlProxiesCert[]
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description string
    (String) Additional notes or information
    insertXauHeader boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name string
    Proxy name for the third-party proxy services
    port number
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type string
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address str
    The IP address or the FQDN of the third-party proxy service
    base64_encode_xau_header bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs Sequence[ForwardingControlProxiesCertArgs]
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description str
    (String) Additional notes or information
    insert_xau_header bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name str
    Proxy name for the third-party proxy services
    port int
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type str
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address String
    The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader Boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs List<Property Map>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description String
    (String) Additional notes or information
    insertXauHeader Boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name String
    Proxy name for the third-party proxy services
    port Number
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    type String
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ForwardingControlProxies resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyId int
    Id string
    The provider-assigned unique ID for this managed resource.
    ProxyId int
    id String
    The provider-assigned unique ID for this managed resource.
    proxyId Integer
    id string
    The provider-assigned unique ID for this managed resource.
    proxyId number
    id str
    The provider-assigned unique ID for this managed resource.
    proxy_id int
    id String
    The provider-assigned unique ID for this managed resource.
    proxyId Number

    Look up Existing ForwardingControlProxies Resource

    Get an existing ForwardingControlProxies resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ForwardingControlProxiesState, opts?: CustomResourceOptions): ForwardingControlProxies
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        base64_encode_xau_header: Optional[bool] = None,
        certs: Optional[Sequence[ForwardingControlProxiesCertArgs]] = None,
        description: Optional[str] = None,
        insert_xau_header: Optional[bool] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        proxy_id: Optional[int] = None,
        type: Optional[str] = None) -> ForwardingControlProxies
    func GetForwardingControlProxies(ctx *Context, name string, id IDInput, state *ForwardingControlProxiesState, opts ...ResourceOption) (*ForwardingControlProxies, error)
    public static ForwardingControlProxies Get(string name, Input<string> id, ForwardingControlProxiesState? state, CustomResourceOptions? opts = null)
    public static ForwardingControlProxies get(String name, Output<String> id, ForwardingControlProxiesState state, CustomResourceOptions options)
    resources:  _:    type: zia:ForwardingControlProxies    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Address string
    The IP address or the FQDN of the third-party proxy service
    Base64EncodeXauHeader bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    Certs List<zscaler.PulumiPackage.Zia.Inputs.ForwardingControlProxiesCert>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    Description string
    (String) Additional notes or information
    InsertXauHeader bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    Name string
    Proxy name for the third-party proxy services
    Port int
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    ProxyId int
    Type string
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    Address string
    The IP address or the FQDN of the third-party proxy service
    Base64EncodeXauHeader bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    Certs []ForwardingControlProxiesCertArgs
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    Description string
    (String) Additional notes or information
    InsertXauHeader bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    Name string
    Proxy name for the third-party proxy services
    Port int
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    ProxyId int
    Type string
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address String
    The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader Boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs List<ForwardingControlProxiesCert>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description String
    (String) Additional notes or information
    insertXauHeader Boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name String
    Proxy name for the third-party proxy services
    port Integer
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    proxyId Integer
    type String
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address string
    The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs ForwardingControlProxiesCert[]
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description string
    (String) Additional notes or information
    insertXauHeader boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name string
    Proxy name for the third-party proxy services
    port number
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    proxyId number
    type string
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address str
    The IP address or the FQDN of the third-party proxy service
    base64_encode_xau_header bool
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs Sequence[ForwardingControlProxiesCertArgs]
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description str
    (String) Additional notes or information
    insert_xau_header bool
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name str
    Proxy name for the third-party proxy services
    port int
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    proxy_id int
    type str
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF
    address String
    The IP address or the FQDN of the third-party proxy service
    base64EncodeXauHeader Boolean
    (Boolean) Flag indicating whether the added X-Authenticated-User header is Base64 encoded. When enabled, the user ID is encoded using the Base64 encoding method.
    certs List<Property Map>
    (Set of Objects) The root certificate used by the third-party proxy to perform SSL inspection. This root certificate is used by Zscaler to validate the SSL leaf certificates signed by the upstream proxy. The required root certificate appears in this drop-down list only if it is uploaded from the Administration > Root Certificates page.
    description String
    (String) Additional notes or information
    insertXauHeader Boolean
    (Boolean) Flag indicating whether X-Authenticated-User header is added by the proxy. Enable to automatically insert authenticated user ID to the HTTP header, X-Authenticated-User.
    name String
    Proxy name for the third-party proxy services
    port Number
    The port number on which the third-party proxy service listens to the requests forwarded from Zscaler
    proxyId Number
    type String
    Gateway type. Supported values: PROXYCHAIN, ZIA, ECSELF

    Supporting Types

    ForwardingControlProxiesCert, ForwardingControlProxiesCertArgs

    Id int
    (Integer) Identifier that uniquely identifies the certificate
    Id int
    (Integer) Identifier that uniquely identifies the certificate
    id Integer
    (Integer) Identifier that uniquely identifies the certificate
    id number
    (Integer) Identifier that uniquely identifies the certificate
    id int
    (Integer) Identifier that uniquely identifies the certificate
    id Number
    (Integer) Identifier that uniquely identifies the certificate

    Import

    Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language.

    Visit

    zia_forwarding_control_proxies can be imported by using <PROXY_ID> or <PROXY_NAME> as the import ID.

    For example:

    $ pulumi import zia:index/forwardingControlProxies:ForwardingControlProxies example <proxy_id>

    or

    $ pulumi import zia:index/forwardingControlProxies:ForwardingControlProxies example <proxy_name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    MIT
    Notes
    This Pulumi package is based on the zia Terraform Provider.
    zia logo
    Zscaler Internet Access v1.1.1 published on Tuesday, Jun 24, 2025 by Zscaler
    zscaler/pulumi-zia