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

zia.getAdminUsers

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_admin_users data source to get information about an admin user account created in the Zscaler Internet Access cloud or via the API. This data source can then be associated with a ZIA administrator role.

    Example Usage

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

const johnDoe = zia.getAdminUsers({
    loginName: "john.doe@example.com",
});

    import pulumi
import pulumi_zia as zia

john_doe = zia.get_admin_users(login_name="john.doe@example.com")

    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.LookupAdminUsers(ctx, &zia.LookupAdminUsersArgs{
			LoginName: pulumi.StringRef("john.doe@example.com"),
		}, 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 johnDoe = Zia.GetAdminUsers.Invoke(new()
    {
        LoginName = "john.doe@example.com",
    });

});

    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.GetAdminUsersArgs;
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 johnDoe = ZiaFunctions.getAdminUsers(GetAdminUsersArgs.builder()
            .loginName("john.doe@example.com")
            .build());

    }
}

    variables:
  johnDoe:
    fn::invoke:
      Function: zia:getAdminUsers
      Arguments:
        loginName: john.doe@example.com

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

const johnDoe = zia.getAdminUsers({
    username: "John Doe",
});

    import pulumi
import pulumi_zia as zia

john_doe = zia.get_admin_users(username="John Doe")

    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.LookupAdminUsers(ctx, &zia.LookupAdminUsersArgs{
			Username: pulumi.StringRef("John Doe"),
		}, 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 johnDoe = Zia.GetAdminUsers.Invoke(new()
    {
        Username = "John Doe",
    });

});

    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.GetAdminUsersArgs;
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 johnDoe = ZiaFunctions.getAdminUsers(GetAdminUsersArgs.builder()
            .username("John Doe")
            .build());

    }
}

    variables:
  johnDoe:
    fn::invoke:
      Function: zia:getAdminUsers
      Arguments:
        username: John Doe

    Using getAdminUsers

    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 getAdminUsers(args: GetAdminUsersArgs, opts?: InvokeOptions): Promise<GetAdminUsersResult>
function getAdminUsersOutput(args: GetAdminUsersOutputArgs, opts?: InvokeOptions): Output<GetAdminUsersResult>
    def get_admin_users(id: Optional[int] = None,
                    login_name: Optional[str] = None,
                    username: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAdminUsersResult
def get_admin_users_output(id: Optional[pulumi.Input[int]] = None,
                    login_name: Optional[pulumi.Input[str]] = None,
                    username: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAdminUsersResult]
    func LookupAdminUsers(ctx *Context, args *LookupAdminUsersArgs, opts ...InvokeOption) (*LookupAdminUsersResult, error)
func LookupAdminUsersOutput(ctx *Context, args *LookupAdminUsersOutputArgs, opts ...InvokeOption) LookupAdminUsersResultOutput

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

    public static class GetAdminUsers 
{
    public static Task<GetAdminUsersResult> InvokeAsync(GetAdminUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetAdminUsersResult> Invoke(GetAdminUsersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAdminUsersResult> getAdminUsers(GetAdminUsersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Id int
    The ID of the admin user to be exported.
    LoginName string
    The email address of the admin user to be exported.
    Username string
    The username of the admin user to be exported.
    Id int
    The ID of the admin user to be exported.
    LoginName string
    The email address of the admin user to be exported.
    Username string
    The username of the admin user to be exported.
    id Integer
    The ID of the admin user to be exported.
    loginName String
    The email address of the admin user to be exported.
    username String
    The username of the admin user to be exported.
    id number
    The ID of the admin user to be exported.
    loginName string
    The email address of the admin user to be exported.
    username string
    The username of the admin user to be exported.
    id int
    The ID of the admin user to be exported.
    login_name str
    The email address of the admin user to be exported.
    username str
    The username of the admin user to be exported.
    id Number
    The ID of the admin user to be exported.
    loginName String
    The email address of the admin user to be exported.
    username String
    The username of the admin user to be exported.

    getAdminUsers Result

    The following output properties are available:

    AdminScopes List<zscaler.PulumiPackage.Zia.Outputs.GetAdminUsersAdminScope>
    (Set of Object) The admin's scope. Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    Comments string
    (String) Additional information about the admin or auditor.
    Disabled bool
    (Boolean) Indicates whether or not the admin account is disabled.
    Email string
    (String) Admin or auditor's email address.
    ExecMobileAppTokens List<zscaler.PulumiPackage.Zia.Outputs.GetAdminUsersExecMobileAppToken>
    (List of Object)
    Id int
    (Number) Identifier that uniquely identifies an entity
    IsAuditor bool
    (Boolean) Indicates whether the user is an auditor. This attribute is subject to change.
    IsExecMobileAppEnabled bool
    (Boolean) Indicates whether or not Executive Insights App access is enabled for the admin.
    IsNonEditable bool
    (Boolean) Indicates whether or not the admin can be edited or deleted.
    IsPasswordExpired bool
    (Boolean) Indicates whether or not an admin's password has expired.
    IsPasswordLoginAllowed bool
    (Boolean) The default is true when SAML Authentication is disabled. When SAML Authentication is enabled, this can be set to false in order to force the admin to login via SSO only.
    IsProductUpdateCommEnabled bool
    (Boolean) Communication setting for Product Update.
    IsSecurityReportCommEnabled bool
    (Boolean) Communication for Security Report is enabled.
    IsServiceUpdateCommEnabled bool
    (Boolean) Communication setting for Service Update.
    LoginName string
    PwdLastModifiedTime int
    Roles List<zscaler.PulumiPackage.Zia.Outputs.GetAdminUsersRole>
    (Set of Object) Role of the admin. This is not required for an auditor.
    Username string
    AdminScopes []GetAdminUsersAdminScope
    (Set of Object) The admin's scope. Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    Comments string
    (String) Additional information about the admin or auditor.
    Disabled bool
    (Boolean) Indicates whether or not the admin account is disabled.
    Email string
    (String) Admin or auditor's email address.
    ExecMobileAppTokens []GetAdminUsersExecMobileAppToken
    (List of Object)
    Id int
    (Number) Identifier that uniquely identifies an entity
    IsAuditor bool
    (Boolean) Indicates whether the user is an auditor. This attribute is subject to change.
    IsExecMobileAppEnabled bool
    (Boolean) Indicates whether or not Executive Insights App access is enabled for the admin.
    IsNonEditable bool
    (Boolean) Indicates whether or not the admin can be edited or deleted.
    IsPasswordExpired bool
    (Boolean) Indicates whether or not an admin's password has expired.
    IsPasswordLoginAllowed bool
    (Boolean) The default is true when SAML Authentication is disabled. When SAML Authentication is enabled, this can be set to false in order to force the admin to login via SSO only.
    IsProductUpdateCommEnabled bool
    (Boolean) Communication setting for Product Update.
    IsSecurityReportCommEnabled bool
    (Boolean) Communication for Security Report is enabled.
    IsServiceUpdateCommEnabled bool
    (Boolean) Communication setting for Service Update.
    LoginName string
    PwdLastModifiedTime int
    Roles []GetAdminUsersRole
    (Set of Object) Role of the admin. This is not required for an auditor.
    Username string
    adminScopes List<GetAdminUsersAdminScope>
    (Set of Object) The admin's scope. Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    comments String
    (String) Additional information about the admin or auditor.
    disabled Boolean
    (Boolean) Indicates whether or not the admin account is disabled.
    email String
    (String) Admin or auditor's email address.
    execMobileAppTokens List<GetAdminUsersExecMobileAppToken>
    (List of Object)
    id Integer
    (Number) Identifier that uniquely identifies an entity
    isAuditor Boolean
    (Boolean) Indicates whether the user is an auditor. This attribute is subject to change.
    isExecMobileAppEnabled Boolean
    (Boolean) Indicates whether or not Executive Insights App access is enabled for the admin.
    isNonEditable Boolean
    (Boolean) Indicates whether or not the admin can be edited or deleted.
    isPasswordExpired Boolean
    (Boolean) Indicates whether or not an admin's password has expired.
    isPasswordLoginAllowed Boolean
    (Boolean) The default is true when SAML Authentication is disabled. When SAML Authentication is enabled, this can be set to false in order to force the admin to login via SSO only.
    isProductUpdateCommEnabled Boolean
    (Boolean) Communication setting for Product Update.
    isSecurityReportCommEnabled Boolean
    (Boolean) Communication for Security Report is enabled.
    isServiceUpdateCommEnabled Boolean
    (Boolean) Communication setting for Service Update.
    loginName String
    pwdLastModifiedTime Integer
    roles List<GetAdminUsersRole>
    (Set of Object) Role of the admin. This is not required for an auditor.
    username String
    adminScopes GetAdminUsersAdminScope[]
    (Set of Object) The admin's scope. Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    comments string
    (String) Additional information about the admin or auditor.
    disabled boolean
    (Boolean) Indicates whether or not the admin account is disabled.
    email string
    (String) Admin or auditor's email address.
    execMobileAppTokens GetAdminUsersExecMobileAppToken[]
    (List of Object)
    id number
    (Number) Identifier that uniquely identifies an entity
    isAuditor boolean
    (Boolean) Indicates whether the user is an auditor. This attribute is subject to change.
    isExecMobileAppEnabled boolean
    (Boolean) Indicates whether or not Executive Insights App access is enabled for the admin.
    isNonEditable boolean
    (Boolean) Indicates whether or not the admin can be edited or deleted.
    isPasswordExpired boolean
    (Boolean) Indicates whether or not an admin's password has expired.
    isPasswordLoginAllowed boolean
    (Boolean) The default is true when SAML Authentication is disabled. When SAML Authentication is enabled, this can be set to false in order to force the admin to login via SSO only.
    isProductUpdateCommEnabled boolean
    (Boolean) Communication setting for Product Update.
    isSecurityReportCommEnabled boolean
    (Boolean) Communication for Security Report is enabled.
    isServiceUpdateCommEnabled boolean
    (Boolean) Communication setting for Service Update.
    loginName string
    pwdLastModifiedTime number
    roles GetAdminUsersRole[]
    (Set of Object) Role of the admin. This is not required for an auditor.
    username string
    admin_scopes Sequence[GetAdminUsersAdminScope]
    (Set of Object) The admin's scope. Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    comments str
    (String) Additional information about the admin or auditor.
    disabled bool
    (Boolean) Indicates whether or not the admin account is disabled.
    email str
    (String) Admin or auditor's email address.
    exec_mobile_app_tokens Sequence[GetAdminUsersExecMobileAppToken]
    (List of Object)
    id int
    (Number) Identifier that uniquely identifies an entity
    is_auditor bool
    (Boolean) Indicates whether the user is an auditor. This attribute is subject to change.
    is_exec_mobile_app_enabled bool
    (Boolean) Indicates whether or not Executive Insights App access is enabled for the admin.
    is_non_editable bool
    (Boolean) Indicates whether or not the admin can be edited or deleted.
    is_password_expired bool
    (Boolean) Indicates whether or not an admin's password has expired.
    is_password_login_allowed bool
    (Boolean) The default is true when SAML Authentication is disabled. When SAML Authentication is enabled, this can be set to false in order to force the admin to login via SSO only.
    is_product_update_comm_enabled bool
    (Boolean) Communication setting for Product Update.
    is_security_report_comm_enabled bool
    (Boolean) Communication for Security Report is enabled.
    is_service_update_comm_enabled bool
    (Boolean) Communication setting for Service Update.
    login_name str
    pwd_last_modified_time int
    roles Sequence[GetAdminUsersRole]
    (Set of Object) Role of the admin. This is not required for an auditor.
    username str
    adminScopes List<Property Map>
    (Set of Object) The admin's scope. Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    comments String
    (String) Additional information about the admin or auditor.
    disabled Boolean
    (Boolean) Indicates whether or not the admin account is disabled.
    email String
    (String) Admin or auditor's email address.
    execMobileAppTokens List<Property Map>
    (List of Object)
    id Number
    (Number) Identifier that uniquely identifies an entity
    isAuditor Boolean
    (Boolean) Indicates whether the user is an auditor. This attribute is subject to change.
    isExecMobileAppEnabled Boolean
    (Boolean) Indicates whether or not Executive Insights App access is enabled for the admin.
    isNonEditable Boolean
    (Boolean) Indicates whether or not the admin can be edited or deleted.
    isPasswordExpired Boolean
    (Boolean) Indicates whether or not an admin's password has expired.
    isPasswordLoginAllowed Boolean
    (Boolean) The default is true when SAML Authentication is disabled. When SAML Authentication is enabled, this can be set to false in order to force the admin to login via SSO only.
    isProductUpdateCommEnabled Boolean
    (Boolean) Communication setting for Product Update.
    isSecurityReportCommEnabled Boolean
    (Boolean) Communication for Security Report is enabled.
    isServiceUpdateCommEnabled Boolean
    (Boolean) Communication setting for Service Update.
    loginName String
    pwdLastModifiedTime Number
    roles List<Property Map>
    (Set of Object) Role of the admin. This is not required for an auditor.
    username String

    Supporting Types

    GetAdminUsersAdminScope

    ScopeEntities List<zscaler.PulumiPackage.Zia.Inputs.GetAdminUsersAdminScopeScopeEntity>
    (String) Based on the admin scope type, the entities can be the ID/name pair of departments, locations, or location groups.
    ScopeGroupMemberEntities List<zscaler.PulumiPackage.Zia.Inputs.GetAdminUsersAdminScopeScopeGroupMemberEntity>
    (Number) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    Type string
    (String) The admin scope type. The attribute name is subject to change.
    ScopeEntities []GetAdminUsersAdminScopeScopeEntity
    (String) Based on the admin scope type, the entities can be the ID/name pair of departments, locations, or location groups.
    ScopeGroupMemberEntities []GetAdminUsersAdminScopeScopeGroupMemberEntity
    (Number) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    Type string
    (String) The admin scope type. The attribute name is subject to change.
    scopeEntities List<GetAdminUsersAdminScopeScopeEntity>
    (String) Based on the admin scope type, the entities can be the ID/name pair of departments, locations, or location groups.
    scopeGroupMemberEntities List<GetAdminUsersAdminScopeScopeGroupMemberEntity>
    (Number) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    type String
    (String) The admin scope type. The attribute name is subject to change.
    scopeEntities GetAdminUsersAdminScopeScopeEntity[]
    (String) Based on the admin scope type, the entities can be the ID/name pair of departments, locations, or location groups.
    scopeGroupMemberEntities GetAdminUsersAdminScopeScopeGroupMemberEntity[]
    (Number) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    type string
    (String) The admin scope type. The attribute name is subject to change.
    scope_entities Sequence[GetAdminUsersAdminScopeScopeEntity]
    (String) Based on the admin scope type, the entities can be the ID/name pair of departments, locations, or location groups.
    scope_group_member_entities Sequence[GetAdminUsersAdminScopeScopeGroupMemberEntity]
    (Number) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    type str
    (String) The admin scope type. The attribute name is subject to change.
    scopeEntities List<Property Map>
    (String) Based on the admin scope type, the entities can be the ID/name pair of departments, locations, or location groups.
    scopeGroupMemberEntities List<Property Map>
    (Number) Only applicable for the LOCATION_GROUP admin scope type, in which case this attribute gives the list of ID/name pairs of locations within the location group.
    type String
    (String) The admin scope type. The attribute name is subject to change.

    GetAdminUsersAdminScopeScopeEntity

    Extensions Dictionary<string, string>
    Id int
    The ID of the admin user to be exported.
    Name string
    (String)
    Extensions map[string]string
    Id int
    The ID of the admin user to be exported.
    Name string
    (String)
    extensions Map<String,String>
    id Integer
    The ID of the admin user to be exported.
    name String
    (String)
    extensions {[key: string]: string}
    id number
    The ID of the admin user to be exported.
    name string
    (String)
    extensions Mapping[str, str]
    id int
    The ID of the admin user to be exported.
    name str
    (String)
    extensions Map<String>
    id Number
    The ID of the admin user to be exported.
    name String
    (String)

    GetAdminUsersAdminScopeScopeGroupMemberEntity

    Extensions Dictionary<string, string>
    Id int
    The ID of the admin user to be exported.
    Name string
    (String)
    Extensions map[string]string
    Id int
    The ID of the admin user to be exported.
    Name string
    (String)
    extensions Map<String,String>
    id Integer
    The ID of the admin user to be exported.
    name String
    (String)
    extensions {[key: string]: string}
    id number
    The ID of the admin user to be exported.
    name string
    (String)
    extensions Mapping[str, str]
    id int
    The ID of the admin user to be exported.
    name str
    (String)
    extensions Map<String>
    id Number
    The ID of the admin user to be exported.
    name String
    (String)

    GetAdminUsersExecMobileAppToken

    Cloud string
    (String)
    CreateTime int
    (Number)
    DeviceId string
    (String)
    DeviceName string
    (String)
    Name string
    (String)
    OrgId int
    (Number)
    Token string
    (String)
    TokenExpiry int
    (Number)
    TokenId string
    (String)
    Cloud string
    (String)
    CreateTime int
    (Number)
    DeviceId string
    (String)
    DeviceName string
    (String)
    Name string
    (String)
    OrgId int
    (Number)
    Token string
    (String)
    TokenExpiry int
    (Number)
    TokenId string
    (String)
    cloud String
    (String)
    createTime Integer
    (Number)
    deviceId String
    (String)
    deviceName String
    (String)
    name String
    (String)
    orgId Integer
    (Number)
    token String
    (String)
    tokenExpiry Integer
    (Number)
    tokenId String
    (String)
    cloud string
    (String)
    createTime number
    (Number)
    deviceId string
    (String)
    deviceName string
    (String)
    name string
    (String)
    orgId number
    (Number)
    token string
    (String)
    tokenExpiry number
    (Number)
    tokenId string
    (String)
    cloud str
    (String)
    create_time int
    (Number)
    device_id str
    (String)
    device_name str
    (String)
    name str
    (String)
    org_id int
    (Number)
    token str
    (String)
    token_expiry int
    (Number)
    token_id str
    (String)
    cloud String
    (String)
    createTime Number
    (Number)
    deviceId String
    (String)
    deviceName String
    (String)
    name String
    (String)
    orgId Number
    (Number)
    token String
    (String)
    tokenExpiry Number
    (Number)
    tokenId String
    (String)

    GetAdminUsersRole

    Extensions Dictionary<string, string>
    Id int
    The ID of the admin user to be exported.
    Name string
    (String)
    Extensions map[string]string
    Id int
    The ID of the admin user to be exported.
    Name string
    (String)
    extensions Map<String,String>
    id Integer
    The ID of the admin user to be exported.
    name String
    (String)
    extensions {[key: string]: string}
    id number
    The ID of the admin user to be exported.
    name string
    (String)
    extensions Mapping[str, str]
    id int
    The ID of the admin user to be exported.
    name str
    (String)
    extensions Map<String>
    id Number
    The ID of the admin user to be exported.
    name String
    (String)

    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