Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getUserManagement
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

zia.getUserManagement

Explore with Pulumi AI

zia logo
Zscaler Internet Access v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
zscaler/pulumi-zia

    Use the zia_user_management data source to get information about a user account that may have been created in the Zscaler Internet Access portal or via API. This data source can then be associated with a ZIA cloud firewall filtering rule, and URL filtering rules.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as zia from "@pulumi/zia";

const adamAshcroft = zia.getUserManagement({
    name: "Adam Ashcroft",
});

    import pulumi
import pulumi_zia as zia

adam_ashcroft = zia.get_user_management(name="Adam Ashcroft")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zia.LookupUserManagement(ctx, &zia.LookupUserManagementArgs{
			Name: pulumi.StringRef("Adam Ashcroft"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zia = Pulumi.Zia;

return await Deployment.RunAsync(() => 
{
    var adamAshcroft = Zia.GetUserManagement.Invoke(new()
    {
        Name = "Adam Ashcroft",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zia.ZiaFunctions;
import com.pulumi.zia.inputs.GetUserManagementArgs;
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 adamAshcroft = ZiaFunctions.getUserManagement(GetUserManagementArgs.builder()
            .name("Adam Ashcroft")
            .build());

    }
}

    variables:
  adamAshcroft:
    fn::invoke:
      Function: zia:getUserManagement
      Arguments:
        name: Adam Ashcroft

    Using getUserManagement

    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 getUserManagement(args: GetUserManagementArgs, opts?: InvokeOptions): Promise<GetUserManagementResult>
function getUserManagementOutput(args: GetUserManagementOutputArgs, opts?: InvokeOptions): Output<GetUserManagementResult>
    def get_user_management(auth_methods: Optional[Sequence[str]] = None,
                        id: Optional[int] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetUserManagementResult
def get_user_management_output(auth_methods: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        id: Optional[pulumi.Input[int]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetUserManagementResult]
    func LookupUserManagement(ctx *Context, args *LookupUserManagementArgs, opts ...InvokeOption) (*LookupUserManagementResult, error)
func LookupUserManagementOutput(ctx *Context, args *LookupUserManagementOutputArgs, opts ...InvokeOption) LookupUserManagementResultOutput

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

    public static class GetUserManagement 
{
    public static Task<GetUserManagementResult> InvokeAsync(GetUserManagementArgs args, InvokeOptions? opts = null)
    public static Output<GetUserManagementResult> Invoke(GetUserManagementInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserManagementResult> getUserManagement(GetUserManagementArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: zia:index/getUserManagement:getUserManagement
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AuthMethods List<string>
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    Id int
    The ID of the time window resource.
    Name string
    User name. This appears when choosing users for policies.
    AuthMethods []string
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    Id int
    The ID of the time window resource.
    Name string
    User name. This appears when choosing users for policies.
    authMethods List<String>
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id Integer
    The ID of the time window resource.
    name String
    User name. This appears when choosing users for policies.
    authMethods string[]
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id number
    The ID of the time window resource.
    name string
    User name. This appears when choosing users for policies.
    auth_methods Sequence[str]
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id int
    The ID of the time window resource.
    name str
    User name. This appears when choosing users for policies.
    authMethods List<String>
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id Number
    The ID of the time window resource.
    name String
    User name. This appears when choosing users for policies.

    getUserManagement Result

    The following output properties are available:

    AdminUser bool
    (String) True if this user is an Admin user. readOnly: true default: false
    Comments string
    (String) Additional information about the group
    Departments List<zscaler.PulumiPackage.Zia.Outputs.GetUserManagementDepartment>
    (String) Department a user belongs to
    Email string
    (Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
    Groups List<zscaler.PulumiPackage.Zia.Outputs.GetUserManagementGroup>
    (String) List of Groups a user belongs to. Groups are used in policies.
    IsAuditor string
    TempAuthEmail string
    (String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
    Type string
    (String) User type. Provided only if this user is not an end user. The supported types are:

    • SUPERADMIN
    • ADMIN
    • AUDITOR
    • GUEST
    • REPORT_USER
    • UNAUTH_TRAFFIC_DEFAULT
    AuthMethods List<string>
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    Id int
    (Number) Unique identfier for the group
    Name string
    (String) Group name
    AdminUser bool
    (String) True if this user is an Admin user. readOnly: true default: false
    Comments string
    (String) Additional information about the group
    Departments []GetUserManagementDepartment
    (String) Department a user belongs to
    Email string
    (Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
    Groups []GetUserManagementGroup
    (String) List of Groups a user belongs to. Groups are used in policies.
    IsAuditor string
    TempAuthEmail string
    (String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
    Type string
    (String) User type. Provided only if this user is not an end user. The supported types are:

    • SUPERADMIN
    • ADMIN
    • AUDITOR
    • GUEST
    • REPORT_USER
    • UNAUTH_TRAFFIC_DEFAULT
    AuthMethods []string
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    Id int
    (Number) Unique identfier for the group
    Name string
    (String) Group name
    adminUser Boolean
    (String) True if this user is an Admin user. readOnly: true default: false
    comments String
    (String) Additional information about the group
    departments List<GetUserManagementDepartment>
    (String) Department a user belongs to
    email String
    (Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
    groups List<GetUserManagementGroup>
    (String) List of Groups a user belongs to. Groups are used in policies.
    isAuditor String
    tempAuthEmail String
    (String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
    type String
    (String) User type. Provided only if this user is not an end user. The supported types are:

    • SUPERADMIN
    • ADMIN
    • AUDITOR
    • GUEST
    • REPORT_USER
    • UNAUTH_TRAFFIC_DEFAULT
    authMethods List<String>
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id Integer
    (Number) Unique identfier for the group
    name String
    (String) Group name
    adminUser boolean
    (String) True if this user is an Admin user. readOnly: true default: false
    comments string
    (String) Additional information about the group
    departments GetUserManagementDepartment[]
    (String) Department a user belongs to
    email string
    (Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
    groups GetUserManagementGroup[]
    (String) List of Groups a user belongs to. Groups are used in policies.
    isAuditor string
    tempAuthEmail string
    (String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
    type string
    (String) User type. Provided only if this user is not an end user. The supported types are:

    • SUPERADMIN
    • ADMIN
    • AUDITOR
    • GUEST
    • REPORT_USER
    • UNAUTH_TRAFFIC_DEFAULT
    authMethods string[]
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id number
    (Number) Unique identfier for the group
    name string
    (String) Group name
    admin_user bool
    (String) True if this user is an Admin user. readOnly: true default: false
    comments str
    (String) Additional information about the group
    departments Sequence[GetUserManagementDepartment]
    (String) Department a user belongs to
    email str
    (Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
    groups Sequence[GetUserManagementGroup]
    (String) List of Groups a user belongs to. Groups are used in policies.
    is_auditor str
    temp_auth_email str
    (String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
    type str
    (String) User type. Provided only if this user is not an end user. The supported types are:

    • SUPERADMIN
    • ADMIN
    • AUDITOR
    • GUEST
    • REPORT_USER
    • UNAUTH_TRAFFIC_DEFAULT
    auth_methods Sequence[str]
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id int
    (Number) Unique identfier for the group
    name str
    (String) Group name
    adminUser Boolean
    (String) True if this user is an Admin user. readOnly: true default: false
    comments String
    (String) Additional information about the group
    departments List<Property Map>
    (String) Department a user belongs to
    email String
    (Required) User email consists of a user name and domain name. It does not have to be a valid email address, but it must be unique and its domain must belong to the organization
    groups List<Property Map>
    (String) List of Groups a user belongs to. Groups are used in policies.
    isAuditor String
    tempAuthEmail String
    (String) Temporary Authentication Email. If you enabled one-time tokens or links, enter the email address to which the Zscaler service sends the tokens or links. If this is empty, the service will send the email to the User email.
    type String
    (String) User type. Provided only if this user is not an end user. The supported types are:

    • SUPERADMIN
    • ADMIN
    • AUDITOR
    • GUEST
    • REPORT_USER
    • UNAUTH_TRAFFIC_DEFAULT
    authMethods List<String>
    (String) Type of authentication method to be enabled. Supported values are: BASIC and DIGEST
    id Number
    (Number) Unique identfier for the group
    name String
    (String) Group name

    Supporting Types

    GetUserManagementDepartment

    Comments string
    (String) Additional information about the group
    Deleted bool
    (Boolean) default: false
    Id int
    The ID of the time window resource.
    IdpId int
    (Number) Unique identfier for the identity provider (IdP)
    Name string
    User name. This appears when choosing users for policies.
    Comments string
    (String) Additional information about the group
    Deleted bool
    (Boolean) default: false
    Id int
    The ID of the time window resource.
    IdpId int
    (Number) Unique identfier for the identity provider (IdP)
    Name string
    User name. This appears when choosing users for policies.
    comments String
    (String) Additional information about the group
    deleted Boolean
    (Boolean) default: false
    id Integer
    The ID of the time window resource.
    idpId Integer
    (Number) Unique identfier for the identity provider (IdP)
    name String
    User name. This appears when choosing users for policies.
    comments string
    (String) Additional information about the group
    deleted boolean
    (Boolean) default: false
    id number
    The ID of the time window resource.
    idpId number
    (Number) Unique identfier for the identity provider (IdP)
    name string
    User name. This appears when choosing users for policies.
    comments str
    (String) Additional information about the group
    deleted bool
    (Boolean) default: false
    id int
    The ID of the time window resource.
    idp_id int
    (Number) Unique identfier for the identity provider (IdP)
    name str
    User name. This appears when choosing users for policies.
    comments String
    (String) Additional information about the group
    deleted Boolean
    (Boolean) default: false
    id Number
    The ID of the time window resource.
    idpId Number
    (Number) Unique identfier for the identity provider (IdP)
    name String
    User name. This appears when choosing users for policies.

    GetUserManagementGroup

    Comments string
    (String) Additional information about the group
    Id int
    The ID of the time window resource.
    IdpId int
    (Number) Unique identfier for the identity provider (IdP)
    Name string
    User name. This appears when choosing users for policies.
    Comments string
    (String) Additional information about the group
    Id int
    The ID of the time window resource.
    IdpId int
    (Number) Unique identfier for the identity provider (IdP)
    Name string
    User name. This appears when choosing users for policies.
    comments String
    (String) Additional information about the group
    id Integer
    The ID of the time window resource.
    idpId Integer
    (Number) Unique identfier for the identity provider (IdP)
    name String
    User name. This appears when choosing users for policies.
    comments string
    (String) Additional information about the group
    id number
    The ID of the time window resource.
    idpId number
    (Number) Unique identfier for the identity provider (IdP)
    name string
    User name. This appears when choosing users for policies.
    comments str
    (String) Additional information about the group
    id int
    The ID of the time window resource.
    idp_id int
    (Number) Unique identfier for the identity provider (IdP)
    name str
    User name. This appears when choosing users for policies.
    comments String
    (String) Additional information about the group
    id Number
    The ID of the time window resource.
    idpId Number
    (Number) Unique identfier for the identity provider (IdP)
    name String
    User name. This appears when choosing users for policies.

    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 v0.0.7 published on Tuesday, Jul 30, 2024 by Zscaler
    zscaler/pulumi-zia