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

zia.getAdminRoles

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

    Example Usage

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

const example = zia.getAdminRoles({
    name: "Super Admin",
});

    import pulumi
import pulumi_zia as zia

example = zia.get_admin_roles(name="Super Admin")

    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.GetAdminRoles(ctx, &zia.GetAdminRolesArgs{
			Name: pulumi.StringRef("Super Admin"),
		}, 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 example = Zia.GetAdminRoles.Invoke(new()
    {
        Name = "Super Admin",
    });

});

    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.GetAdminRolesArgs;
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 example = ZiaFunctions.getAdminRoles(GetAdminRolesArgs.builder()
            .name("Super Admin")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: zia:getAdminRoles
      Arguments:
        name: Super Admin

    Using getAdminRoles

    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 getAdminRoles(args: GetAdminRolesArgs, opts?: InvokeOptions): Promise<GetAdminRolesResult>
function getAdminRolesOutput(args: GetAdminRolesOutputArgs, opts?: InvokeOptions): Output<GetAdminRolesResult>
    def get_admin_roles(name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetAdminRolesResult
def get_admin_roles_output(name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetAdminRolesResult]
    func GetAdminRoles(ctx *Context, args *GetAdminRolesArgs, opts ...InvokeOption) (*GetAdminRolesResult, error)
func GetAdminRolesOutput(ctx *Context, args *GetAdminRolesOutputArgs, opts ...InvokeOption) GetAdminRolesResultOutput

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

    public static class GetAdminRoles 
{
    public static Task<GetAdminRolesResult> InvokeAsync(GetAdminRolesArgs args, InvokeOptions? opts = null)
    public static Output<GetAdminRolesResult> Invoke(GetAdminRolesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAdminRolesResult> getAdminRoles(GetAdminRolesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Name string
    The name of the Admin role to be exported.
    Name string
    The name of the Admin role to be exported.
    name String
    The name of the Admin role to be exported.
    name string
    The name of the Admin role to be exported.
    name str
    The name of the Admin role to be exported.
    name String
    The name of the Admin role to be exported.

    getAdminRoles Result

    The following output properties are available:

    AdminAcctAccess string
    (String)
    AnalysisAccess string
    (String)
    DashboardAccess string
    (String) Dashboard access permission. Supported values are: NONE, READ_ONLY
    Id int
    IsAuditor bool
    (Boolean) Indicates whether this is an auditor role.
    IsNonEditable bool
    (Boolean) Indicates whether or not this admin user is editable/deletable.
    LogsLimit string
    (String) Log range limit. Returned values are: UNRESTRICTED, MONTH_1, MONTH_2, MONTH_3, MONTH_4, MONTH_5, MONTH_6
    Permissions List<string>
    (List of String) List of functional areas to which this role has access. This attribute is subject to change.
    PolicyAccess string
    (String) Policy access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    Rank int
    (Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
    ReportAccess string
    (String) Report access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    RoleType string
    (String) The admin role type. ()This attribute is subject to change.) Supported values are: ORG_ADMIN, EXEC_INSIGHT, EXEC_INSIGHT_AND_ORG_ADMIN, SDWAN
    UsernameAccess string
    (String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: NONE|READ_ONLY
    Name string
    AdminAcctAccess string
    (String)
    AnalysisAccess string
    (String)
    DashboardAccess string
    (String) Dashboard access permission. Supported values are: NONE, READ_ONLY
    Id int
    IsAuditor bool
    (Boolean) Indicates whether this is an auditor role.
    IsNonEditable bool
    (Boolean) Indicates whether or not this admin user is editable/deletable.
    LogsLimit string
    (String) Log range limit. Returned values are: UNRESTRICTED, MONTH_1, MONTH_2, MONTH_3, MONTH_4, MONTH_5, MONTH_6
    Permissions []string
    (List of String) List of functional areas to which this role has access. This attribute is subject to change.
    PolicyAccess string
    (String) Policy access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    Rank int
    (Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
    ReportAccess string
    (String) Report access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    RoleType string
    (String) The admin role type. ()This attribute is subject to change.) Supported values are: ORG_ADMIN, EXEC_INSIGHT, EXEC_INSIGHT_AND_ORG_ADMIN, SDWAN
    UsernameAccess string
    (String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: NONE|READ_ONLY
    Name string
    adminAcctAccess String
    (String)
    analysisAccess String
    (String)
    dashboardAccess String
    (String) Dashboard access permission. Supported values are: NONE, READ_ONLY
    id Integer
    isAuditor Boolean
    (Boolean) Indicates whether this is an auditor role.
    isNonEditable Boolean
    (Boolean) Indicates whether or not this admin user is editable/deletable.
    logsLimit String
    (String) Log range limit. Returned values are: UNRESTRICTED, MONTH_1, MONTH_2, MONTH_3, MONTH_4, MONTH_5, MONTH_6
    permissions List<String>
    (List of String) List of functional areas to which this role has access. This attribute is subject to change.
    policyAccess String
    (String) Policy access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    rank Integer
    (Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
    reportAccess String
    (String) Report access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    roleType String
    (String) The admin role type. ()This attribute is subject to change.) Supported values are: ORG_ADMIN, EXEC_INSIGHT, EXEC_INSIGHT_AND_ORG_ADMIN, SDWAN
    usernameAccess String
    (String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: NONE|READ_ONLY
    name String
    adminAcctAccess string
    (String)
    analysisAccess string
    (String)
    dashboardAccess string
    (String) Dashboard access permission. Supported values are: NONE, READ_ONLY
    id number
    isAuditor boolean
    (Boolean) Indicates whether this is an auditor role.
    isNonEditable boolean
    (Boolean) Indicates whether or not this admin user is editable/deletable.
    logsLimit string
    (String) Log range limit. Returned values are: UNRESTRICTED, MONTH_1, MONTH_2, MONTH_3, MONTH_4, MONTH_5, MONTH_6
    permissions string[]
    (List of String) List of functional areas to which this role has access. This attribute is subject to change.
    policyAccess string
    (String) Policy access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    rank number
    (Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
    reportAccess string
    (String) Report access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    roleType string
    (String) The admin role type. ()This attribute is subject to change.) Supported values are: ORG_ADMIN, EXEC_INSIGHT, EXEC_INSIGHT_AND_ORG_ADMIN, SDWAN
    usernameAccess string
    (String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: NONE|READ_ONLY
    name string
    admin_acct_access str
    (String)
    analysis_access str
    (String)
    dashboard_access str
    (String) Dashboard access permission. Supported values are: NONE, READ_ONLY
    id int
    is_auditor bool
    (Boolean) Indicates whether this is an auditor role.
    is_non_editable bool
    (Boolean) Indicates whether or not this admin user is editable/deletable.
    logs_limit str
    (String) Log range limit. Returned values are: UNRESTRICTED, MONTH_1, MONTH_2, MONTH_3, MONTH_4, MONTH_5, MONTH_6
    permissions Sequence[str]
    (List of String) List of functional areas to which this role has access. This attribute is subject to change.
    policy_access str
    (String) Policy access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    rank int
    (Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
    report_access str
    (String) Report access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    role_type str
    (String) The admin role type. ()This attribute is subject to change.) Supported values are: ORG_ADMIN, EXEC_INSIGHT, EXEC_INSIGHT_AND_ORG_ADMIN, SDWAN
    username_access str
    (String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: NONE|READ_ONLY
    name str
    adminAcctAccess String
    (String)
    analysisAccess String
    (String)
    dashboardAccess String
    (String) Dashboard access permission. Supported values are: NONE, READ_ONLY
    id Number
    isAuditor Boolean
    (Boolean) Indicates whether this is an auditor role.
    isNonEditable Boolean
    (Boolean) Indicates whether or not this admin user is editable/deletable.
    logsLimit String
    (String) Log range limit. Returned values are: UNRESTRICTED, MONTH_1, MONTH_2, MONTH_3, MONTH_4, MONTH_5, MONTH_6
    permissions List<String>
    (List of String) List of functional areas to which this role has access. This attribute is subject to change.
    policyAccess String
    (String) Policy access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    rank Number
    (Number) Admin rank of this admin role. This is applicable only when admin rank is enabled in the advanced settings. Default value is 7 (the lowest rank). The assigned admin rank determines the roles or admin users this user can manage, and which rule orders this admin can access.
    reportAccess String
    (String) Report access permission. Returned values are: NONE, READ_ONLY,READ_WRITE
    roleType String
    (String) The admin role type. ()This attribute is subject to change.) Supported values are: ORG_ADMIN, EXEC_INSIGHT, EXEC_INSIGHT_AND_ORG_ADMIN, SDWAN
    usernameAccess String
    (String) Username access permission. When set to NONE, the username will be obfuscated. Supported values are: NONE|READ_ONLY
    name 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