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

zpa.UserPortalAUP

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_aup 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.UserPortalAUP("this", {
    name: "Org_AUP01",
    description: "Org_AUP01",
    enabled: true,
    aup: "Org_AUP01",
    email: "company@acme.com",
    phoneNum: "+1 123-1458",
});

    import pulumi
import zscaler_pulumi_zpa as zpa

this = zpa.UserPortalAUP("this",
    name="Org_AUP01",
    description="Org_AUP01",
    enabled=True,
    aup="Org_AUP01",
    email="company@acme.com",
    phone_num="+1 123-1458")

    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.NewUserPortalAUP(ctx, "this", &zpa.UserPortalAUPArgs{
			Name:        pulumi.String("Org_AUP01"),
			Description: pulumi.String("Org_AUP01"),
			Enabled:     pulumi.Bool(true),
			Aup:         pulumi.String("Org_AUP01"),
			Email:       pulumi.String("company@acme.com"),
			PhoneNum:    pulumi.String("+1 123-1458"),
		})
		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.UserPortalAUP("this", new()
    {
        Name = "Org_AUP01",
        Description = "Org_AUP01",
        Enabled = true,
        Aup = "Org_AUP01",
        Email = "company@acme.com",
        PhoneNum = "+1 123-1458",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zpa.UserPortalAUP;
import com.pulumi.zpa.UserPortalAUPArgs;
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 UserPortalAUP("this", UserPortalAUPArgs.builder()
            .name("Org_AUP01")
            .description("Org_AUP01")
            .enabled(true)
            .aup("Org_AUP01")
            .email("company@acme.com")
            .phoneNum("+1 123-1458")
            .build());

    }
}

    resources:
  this:
    type: zpa:UserPortalAUP
    properties:
      name: Org_AUP01
      description: Org_AUP01
      enabled: true
      aup: Org_AUP01
      email: company@acme.com
      phoneNum: +1 123-1458

    Create UserPortalAUP Resource

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

    Constructor syntax

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

@overload
def UserPortalAUP(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  aup: Optional[str] = None,
                  description: Optional[str] = None,
                  email: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  microtenant_id: Optional[str] = None,
                  name: Optional[str] = None,
                  phone_num: Optional[str] = None)
    func NewUserPortalAUP(ctx *Context, name string, args *UserPortalAUPArgs, opts ...ResourceOption) (*UserPortalAUP, error)
    public UserPortalAUP(string name, UserPortalAUPArgs? args = null, CustomResourceOptions? opts = null)
    public UserPortalAUP(String name, UserPortalAUPArgs args)
public UserPortalAUP(String name, UserPortalAUPArgs args, CustomResourceOptions options)

    type: zpa:UserPortalAUP
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 UserPortalAUPArgs
    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 UserPortalAUPArgs
    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 UserPortalAUPArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPortalAUPArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPortalAUPArgs
    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 userPortalAUPResource = new Zpa.UserPortalAUP("userPortalAUPResource", new()
{
    Aup = "string",
    Description = "string",
    Email = "string",
    Enabled = false,
    MicrotenantId = "string",
    Name = "string",
    PhoneNum = "string",
});

    example, err := zpa.NewUserPortalAUP(ctx, "userPortalAUPResource", &zpa.UserPortalAUPArgs{
	Aup:           pulumi.String("string"),
	Description:   pulumi.String("string"),
	Email:         pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	MicrotenantId: pulumi.String("string"),
	Name:          pulumi.String("string"),
	PhoneNum:      pulumi.String("string"),
})

    var userPortalAUPResource = new UserPortalAUP("userPortalAUPResource", UserPortalAUPArgs.builder()
    .aup("string")
    .description("string")
    .email("string")
    .enabled(false)
    .microtenantId("string")
    .name("string")
    .phoneNum("string")
    .build());

    user_portal_aup_resource = zpa.UserPortalAUP("userPortalAUPResource",
    aup="string",
    description="string",
    email="string",
    enabled=False,
    microtenant_id="string",
    name="string",
    phone_num="string")

    const userPortalAUPResource = new zpa.UserPortalAUP("userPortalAUPResource", {
    aup: "string",
    description: "string",
    email: "string",
    enabled: false,
    microtenantId: "string",
    name: "string",
    phoneNum: "string",
});

    type: zpa:UserPortalAUP
properties:
    aup: string
    description: string
    email: string
    enabled: false
    microtenantId: string
    name: string
    phoneNum: string

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

    Aup string
    • (String)
    Description string
    • (String) Description of the User Portal AUP
    Email string
    • (String)
    Enabled bool
    • (Boolean) Whether this User Portal AUP is enabled or not
    MicrotenantId string
    Name string
    • Name of the User Portal AUP
    PhoneNum string
    • (String)
    Aup string
    • (String)
    Description string
    • (String) Description of the User Portal AUP
    Email string
    • (String)
    Enabled bool
    • (Boolean) Whether this User Portal AUP is enabled or not
    MicrotenantId string
    Name string
    • Name of the User Portal AUP
    PhoneNum string
    • (String)
    aup String
    • (String)
    description String
    • (String) Description of the User Portal AUP
    email String
    • (String)
    enabled Boolean
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenantId String
    name String
    • Name of the User Portal AUP
    phoneNum String
    • (String)
    aup string
    • (String)
    description string
    • (String) Description of the User Portal AUP
    email string
    • (String)
    enabled boolean
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenantId string
    name string
    • Name of the User Portal AUP
    phoneNum string
    • (String)
    aup str
    • (String)
    description str
    • (String) Description of the User Portal AUP
    email str
    • (String)
    enabled bool
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenant_id str
    name str
    • Name of the User Portal AUP
    phone_num str
    • (String)
    aup String
    • (String)
    description String
    • (String) Description of the User Portal AUP
    email String
    • (String)
    enabled Boolean
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenantId String
    name String
    • Name of the User Portal AUP
    phoneNum String
    • (String)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPortalAUP 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 UserPortalAUP Resource

    Get an existing UserPortalAUP 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?: UserPortalAUPState, opts?: CustomResourceOptions): UserPortalAUP
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aup: Optional[str] = None,
        description: Optional[str] = None,
        email: Optional[str] = None,
        enabled: Optional[bool] = None,
        microtenant_id: Optional[str] = None,
        name: Optional[str] = None,
        phone_num: Optional[str] = None) -> UserPortalAUP
    func GetUserPortalAUP(ctx *Context, name string, id IDInput, state *UserPortalAUPState, opts ...ResourceOption) (*UserPortalAUP, error)
    public static UserPortalAUP Get(string name, Input<string> id, UserPortalAUPState? state, CustomResourceOptions? opts = null)
    public static UserPortalAUP get(String name, Output<String> id, UserPortalAUPState state, CustomResourceOptions options)
    resources:  _:    type: zpa:UserPortalAUP    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:
    Aup string
    • (String)
    Description string
    • (String) Description of the User Portal AUP
    Email string
    • (String)
    Enabled bool
    • (Boolean) Whether this User Portal AUP is enabled or not
    MicrotenantId string
    Name string
    • Name of the User Portal AUP
    PhoneNum string
    • (String)
    Aup string
    • (String)
    Description string
    • (String) Description of the User Portal AUP
    Email string
    • (String)
    Enabled bool
    • (Boolean) Whether this User Portal AUP is enabled or not
    MicrotenantId string
    Name string
    • Name of the User Portal AUP
    PhoneNum string
    • (String)
    aup String
    • (String)
    description String
    • (String) Description of the User Portal AUP
    email String
    • (String)
    enabled Boolean
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenantId String
    name String
    • Name of the User Portal AUP
    phoneNum String
    • (String)
    aup string
    • (String)
    description string
    • (String) Description of the User Portal AUP
    email string
    • (String)
    enabled boolean
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenantId string
    name string
    • Name of the User Portal AUP
    phoneNum string
    • (String)
    aup str
    • (String)
    description str
    • (String) Description of the User Portal AUP
    email str
    • (String)
    enabled bool
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenant_id str
    name str
    • Name of the User Portal AUP
    phone_num str
    • (String)
    aup String
    • (String)
    description String
    • (String) Description of the User Portal AUP
    email String
    • (String)
    enabled Boolean
    • (Boolean) Whether this User Portal AUP is enabled or not
    microtenantId String
    name String
    • Name of the User Portal AUP
    phoneNum String
    • (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

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

    For example:

    $ pulumi import zpa:index/userPortalAUP:UserPortalAUP example <portal_id>

    or

    $ pulumi import zpa:index/userPortalAUP:UserPortalAUP 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