1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getUserPortalLink
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
zpa logo
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler

    The zpa_user_portal_link data source to get information about 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 = zpa.getUserPortalLink({
        name: "server1.example.com",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    this = zpa.get_user_portal_link(name="server1.example.com")
    
    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.LookupUserPortalLink(ctx, &zpa.LookupUserPortalLinkArgs{
    			Name: pulumi.StringRef("server1.example.com"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zpa = Pulumi.Zpa;
    
    return await Deployment.RunAsync(() => 
    {
        var @this = Zpa.GetUserPortalLink.Invoke(new()
        {
            Name = "server1.example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zpa.ZpaFunctions;
    import com.pulumi.zpa.inputs.GetUserPortalLinkArgs;
    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) {
            final var this = ZpaFunctions.getUserPortalLink(GetUserPortalLinkArgs.builder()
                .name("server1.example.com")
                .build());
    
        }
    }
    
    variables:
      this:
        fn::invoke:
          function: zpa:getUserPortalLink
          arguments:
            name: server1.example.com
    

    Using getUserPortalLink

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getUserPortalLink(args: GetUserPortalLinkArgs, opts?: InvokeOptions): Promise<GetUserPortalLinkResult>
    function getUserPortalLinkOutput(args: GetUserPortalLinkOutputArgs, opts?: InvokeOptions): Output<GetUserPortalLinkResult>
    def get_user_portal_link(id: Optional[str] = None,
                             microtenant_id: Optional[str] = None,
                             name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetUserPortalLinkResult
    def get_user_portal_link_output(id: Optional[pulumi.Input[str]] = None,
                             microtenant_id: Optional[pulumi.Input[str]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetUserPortalLinkResult]
    func LookupUserPortalLink(ctx *Context, args *LookupUserPortalLinkArgs, opts ...InvokeOption) (*LookupUserPortalLinkResult, error)
    func LookupUserPortalLinkOutput(ctx *Context, args *LookupUserPortalLinkOutputArgs, opts ...InvokeOption) LookupUserPortalLinkResultOutput

    > Note: This function is named LookupUserPortalLink in the Go SDK.

    public static class GetUserPortalLink 
    {
        public static Task<GetUserPortalLinkResult> InvokeAsync(GetUserPortalLinkArgs args, InvokeOptions? opts = null)
        public static Output<GetUserPortalLinkResult> Invoke(GetUserPortalLinkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserPortalLinkResult> getUserPortalLink(GetUserPortalLinkArgs args, InvokeOptions options)
    public static Output<GetUserPortalLinkResult> getUserPortalLink(GetUserPortalLinkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getUserPortalLink:getUserPortalLink
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    MicrotenantId string
    Name string
    Id string
    MicrotenantId string
    Name string
    id String
    microtenantId String
    name String
    id string
    microtenantId string
    name string
    id String
    microtenantId String
    name String

    getUserPortalLink Result

    The following output properties are available:

    Supporting Types

    GetUserPortalLinkUserPortal

    Enabled bool
    Id string
    Name string
    Enabled bool
    Id string
    Name string
    enabled Boolean
    id String
    name String
    enabled boolean
    id string
    name string
    enabled bool
    id str
    name str
    enabled Boolean
    id String
    name String

    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
      Meet Neo: Your AI Platform Teammate