1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. UserPortalLink
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zpa

zpa.UserPortalLink

zpa logo
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zpa

    The zpa_user_portal_link resource creates a user portal link in the Zscaler Private Access cloud.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as zpa from "@bdzscaler/pulumi-zpa";

const _this = new zpa.UserPortalLink("this", {
    name: "server1.example.com",
    description: "server1.example.com",
    enabled: true,
    link: "server1.example.com",
    iconText: "",
    protocol: "https://",
    userPortals: [{
        ids: [thisZpaUserPortalController.id],
    }],
});

    import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.UserPortalLink("this",
    name="server1.example.com",
    description="server1.example.com",
    enabled=True,
    link="server1.example.com",
    icon_text="",
    protocol="https://",
    user_portals=[{
        "ids": [this_zpa_user_portal_controller["id"]],
    }])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/zscaler/pulumi-zpa/sdk/go/zpa"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zpa.NewUserPortalLink(ctx, "this", &zpa.UserPortalLinkArgs{
			Name:        pulumi.String("server1.example.com"),
			Description: pulumi.String("server1.example.com"),
			Enabled:     pulumi.Bool(true),
			Link:        pulumi.String("server1.example.com"),
			IconText:    pulumi.String(""),
			Protocol:    pulumi.String("https://"),
			UserPortals: zpa.UserPortalLinkUserPortalArray{
				&zpa.UserPortalLinkUserPortalArgs{
					Ids: pulumi.StringArray{
						thisZpaUserPortalController.Id,
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zpa = zscaler.PulumiPackage.Zpa;

return await Deployment.RunAsync(() => 
{
    var @this = new Zpa.UserPortalLink("this", new()
    {
        Name = "server1.example.com",
        Description = "server1.example.com",
        Enabled = true,
        Link = "server1.example.com",
        IconText = "",
        Protocol = "https://",
        UserPortals = new[]
        {
            new Zpa.Inputs.UserPortalLinkUserPortalArgs
            {
                Ids = new[]
                {
                    thisZpaUserPortalController.Id,
                },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.UserPortalLink;
import com.pulumi.zpa.UserPortalLinkArgs;
import com.pulumi.zpa.inputs.UserPortalLinkUserPortalArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var this_ = new UserPortalLink("this", UserPortalLinkArgs.builder()
            .name("server1.example.com")
            .description("server1.example.com")
            .enabled(true)
            .link("server1.example.com")
            .iconText("")
            .protocol("https://")
            .userPortals(UserPortalLinkUserPortalArgs.builder()
                .ids(thisZpaUserPortalController.id())
                .build())
            .build());

    }
}

    resources:
  this:
    type: zpa:UserPortalLink
    properties:
      name: server1.example.com
      description: server1.example.com
      enabled: true
      link: server1.example.com
      iconText: ""
      protocol: https://
      userPortals:
        - ids:
            - ${thisZpaUserPortalController.id}

    Create UserPortalLink Resource

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

    Constructor syntax

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

@overload
def UserPortalLink(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   description: Optional[str] = None,
                   enabled: Optional[bool] = None,
                   icon_text: Optional[str] = None,
                   link: Optional[str] = None,
                   link_path: Optional[str] = None,
                   microtenant_id: Optional[str] = None,
                   name: Optional[str] = None,
                   protocol: Optional[str] = None,
                   user_portals: Optional[Sequence[UserPortalLinkUserPortalArgs]] = None)
    func NewUserPortalLink(ctx *Context, name string, args *UserPortalLinkArgs, opts ...ResourceOption) (*UserPortalLink, error)
    public UserPortalLink(string name, UserPortalLinkArgs? args = null, CustomResourceOptions? opts = null)
    public UserPortalLink(String name, UserPortalLinkArgs args)
public UserPortalLink(String name, UserPortalLinkArgs args, CustomResourceOptions options)

    type: zpa:UserPortalLink
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 UserPortalLinkArgs
    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 UserPortalLinkArgs
    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 UserPortalLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPortalLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPortalLinkArgs
    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 userPortalLinkResource = new Zpa.UserPortalLink("userPortalLinkResource", new()
{
    Description = "string",
    Enabled = false,
    IconText = "string",
    Link = "string",
    LinkPath = "string",
    MicrotenantId = "string",
    Name = "string",
    Protocol = "string",
    UserPortals = new[]
    {
        new Zpa.Inputs.UserPortalLinkUserPortalArgs
        {
            Ids = new[]
            {
                "string",
            },
        },
    },
});

    example, err := zpa.NewUserPortalLink(ctx, "userPortalLinkResource", &zpa.UserPortalLinkArgs{
	Description:   pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	IconText:      pulumi.String("string"),
	Link:          pulumi.String("string"),
	LinkPath:      pulumi.String("string"),
	MicrotenantId: pulumi.String("string"),
	Name:          pulumi.String("string"),
	Protocol:      pulumi.String("string"),
	UserPortals: zpa.UserPortalLinkUserPortalArray{
		&zpa.UserPortalLinkUserPortalArgs{
			Ids: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
})

    var userPortalLinkResource = new UserPortalLink("userPortalLinkResource", UserPortalLinkArgs.builder()
    .description("string")
    .enabled(false)
    .iconText("string")
    .link("string")
    .linkPath("string")
    .microtenantId("string")
    .name("string")
    .protocol("string")
    .userPortals(UserPortalLinkUserPortalArgs.builder()
        .ids("string")
        .build())
    .build());

    user_portal_link_resource = zpa.UserPortalLink("userPortalLinkResource",
    description="string",
    enabled=False,
    icon_text="string",
    link="string",
    link_path="string",
    microtenant_id="string",
    name="string",
    protocol="string",
    user_portals=[{
        "ids": ["string"],
    }])

    const userPortalLinkResource = new zpa.UserPortalLink("userPortalLinkResource", {
    description: "string",
    enabled: false,
    iconText: "string",
    link: "string",
    linkPath: "string",
    microtenantId: "string",
    name: "string",
    protocol: "string",
    userPortals: [{
        ids: ["string"],
    }],
});

    type: zpa:UserPortalLink
properties:
    description: string
    enabled: false
    iconText: string
    link: string
    linkPath: string
    microtenantId: string
    name: string
    protocol: string
    userPortals:
        - ids:
            - string

    UserPortalLink 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 UserPortalLink resource accepts the following input properties:

    Description string
    Description of the User Portal Link
    Enabled bool
    Whether this User Portal Link is enabled or not
    IconText string
    Icon text for the User Portal Link
    Link string
    Link URL for the User Portal Link
    LinkPath string
    Link path for the User Portal Link
    MicrotenantId string
    Microtenant ID for the User Portal Link
    Name string
    Name of the User Portal Link
    Protocol string
    Protocol for the User Portal Link
    UserPortals List<zscaler.PulumiPackage.Zpa.Inputs.UserPortalLinkUserPortal>
    List of User Portals
    Description string
    Description of the User Portal Link
    Enabled bool
    Whether this User Portal Link is enabled or not
    IconText string
    Icon text for the User Portal Link
    Link string
    Link URL for the User Portal Link
    LinkPath string
    Link path for the User Portal Link
    MicrotenantId string
    Microtenant ID for the User Portal Link
    Name string
    Name of the User Portal Link
    Protocol string
    Protocol for the User Portal Link
    UserPortals []UserPortalLinkUserPortalArgs
    List of User Portals
    description String
    Description of the User Portal Link
    enabled Boolean
    Whether this User Portal Link is enabled or not
    iconText String
    Icon text for the User Portal Link
    link String
    Link URL for the User Portal Link
    linkPath String
    Link path for the User Portal Link
    microtenantId String
    Microtenant ID for the User Portal Link
    name String
    Name of the User Portal Link
    protocol String
    Protocol for the User Portal Link
    userPortals List<UserPortalLinkUserPortal>
    List of User Portals
    description string
    Description of the User Portal Link
    enabled boolean
    Whether this User Portal Link is enabled or not
    iconText string
    Icon text for the User Portal Link
    link string
    Link URL for the User Portal Link
    linkPath string
    Link path for the User Portal Link
    microtenantId string
    Microtenant ID for the User Portal Link
    name string
    Name of the User Portal Link
    protocol string
    Protocol for the User Portal Link
    userPortals UserPortalLinkUserPortal[]
    List of User Portals
    description str
    Description of the User Portal Link
    enabled bool
    Whether this User Portal Link is enabled or not
    icon_text str
    Icon text for the User Portal Link
    link str
    Link URL for the User Portal Link
    link_path str
    Link path for the User Portal Link
    microtenant_id str
    Microtenant ID for the User Portal Link
    name str
    Name of the User Portal Link
    protocol str
    Protocol for the User Portal Link
    user_portals Sequence[UserPortalLinkUserPortalArgs]
    List of User Portals
    description String
    Description of the User Portal Link
    enabled Boolean
    Whether this User Portal Link is enabled or not
    iconText String
    Icon text for the User Portal Link
    link String
    Link URL for the User Portal Link
    linkPath String
    Link path for the User Portal Link
    microtenantId String
    Microtenant ID for the User Portal Link
    name String
    Name of the User Portal Link
    protocol String
    Protocol for the User Portal Link
    userPortals List<Property Map>
    List of User Portals

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserPortalLink Resource

    Get an existing UserPortalLink 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?: UserPortalLinkState, opts?: CustomResourceOptions): UserPortalLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        icon_text: Optional[str] = None,
        link: Optional[str] = None,
        link_path: Optional[str] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        protocol: Optional[str] = None,
        user_portals: Optional[Sequence[UserPortalLinkUserPortalArgs]] = None) -> UserPortalLink
    func GetUserPortalLink(ctx *Context, name string, id IDInput, state *UserPortalLinkState, opts ...ResourceOption) (*UserPortalLink, error)
    public static UserPortalLink Get(string name, Input<string> id, UserPortalLinkState? state, CustomResourceOptions? opts = null)
    public static UserPortalLink get(String name, Output<String> id, UserPortalLinkState state, CustomResourceOptions options)
    resources:  _:    type: zpa:UserPortalLink    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:
    Description string
    Description of the User Portal Link
    Enabled bool
    Whether this User Portal Link is enabled or not
    IconText string
    Icon text for the User Portal Link
    Link string
    Link URL for the User Portal Link
    LinkPath string
    Link path for the User Portal Link
    MicrotenantId string
    Microtenant ID for the User Portal Link
    Name string
    Name of the User Portal Link
    Protocol string
    Protocol for the User Portal Link
    UserPortals List<zscaler.PulumiPackage.Zpa.Inputs.UserPortalLinkUserPortal>
    List of User Portals
    Description string
    Description of the User Portal Link
    Enabled bool
    Whether this User Portal Link is enabled or not
    IconText string
    Icon text for the User Portal Link
    Link string
    Link URL for the User Portal Link
    LinkPath string
    Link path for the User Portal Link
    MicrotenantId string
    Microtenant ID for the User Portal Link
    Name string
    Name of the User Portal Link
    Protocol string
    Protocol for the User Portal Link
    UserPortals []UserPortalLinkUserPortalArgs
    List of User Portals
    description String
    Description of the User Portal Link
    enabled Boolean
    Whether this User Portal Link is enabled or not
    iconText String
    Icon text for the User Portal Link
    link String
    Link URL for the User Portal Link
    linkPath String
    Link path for the User Portal Link
    microtenantId String
    Microtenant ID for the User Portal Link
    name String
    Name of the User Portal Link
    protocol String
    Protocol for the User Portal Link
    userPortals List<UserPortalLinkUserPortal>
    List of User Portals
    description string
    Description of the User Portal Link
    enabled boolean
    Whether this User Portal Link is enabled or not
    iconText string
    Icon text for the User Portal Link
    link string
    Link URL for the User Portal Link
    linkPath string
    Link path for the User Portal Link
    microtenantId string
    Microtenant ID for the User Portal Link
    name string
    Name of the User Portal Link
    protocol string
    Protocol for the User Portal Link
    userPortals UserPortalLinkUserPortal[]
    List of User Portals
    description str
    Description of the User Portal Link
    enabled bool
    Whether this User Portal Link is enabled or not
    icon_text str
    Icon text for the User Portal Link
    link str
    Link URL for the User Portal Link
    link_path str
    Link path for the User Portal Link
    microtenant_id str
    Microtenant ID for the User Portal Link
    name str
    Name of the User Portal Link
    protocol str
    Protocol for the User Portal Link
    user_portals Sequence[UserPortalLinkUserPortalArgs]
    List of User Portals
    description String
    Description of the User Portal Link
    enabled Boolean
    Whether this User Portal Link is enabled or not
    iconText String
    Icon text for the User Portal Link
    link String
    Link URL for the User Portal Link
    linkPath String
    Link path for the User Portal Link
    microtenantId String
    Microtenant ID for the User Portal Link
    name String
    Name of the User Portal Link
    protocol String
    Protocol for the User Portal Link
    userPortals List<Property Map>
    List of User Portals

    Supporting Types

    UserPortalLinkUserPortal, UserPortalLinkUserPortalArgs

    Ids List<string>
    Ids []string
    ids List<String>
    ids string[]
    ids Sequence[str]
    ids List<String>

    Import

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

    Visit

    user_portal_controller can be imported by using <USER PORTAL ID> or <USER PORTAL NAME> as the import ID.

    For example:

    $ pulumi import zpa:index/userPortalLink:UserPortalLink example <portal_id>

    or

    $ pulumi import zpa:index/userPortalLink:UserPortalLink example <portal_name>

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

    Package Details

    Repository
    zpa zscaler/pulumi-zpa
    License
    MIT
    Notes
    This Pulumi package is based on the zpa Terraform Provider.
    zpa logo
    Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zpa
      Meet Neo: Your AI Platform Teammate