1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getSCIMGroups
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

zpa.getSCIMGroups

Explore with Pulumi AI

zpa logo
Zscaler Private Access v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler

    Use the zpa_scim_groups data source to get information about a SCIM Group from an Identity Provider (IdP). This data source can then be referenced in an Access Policy, Timeout policy, Forwarding Policy, Inspection Policy or Isolation Policy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@pulumi/zpa";
    
    const engineering = zpa.getSCIMGroups({
        idpName: "idp_name",
        name: "Engineering",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    engineering = zpa.get_scim_groups(idp_name="idp_name",
        name="Engineering")
    
    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.GetSCIMGroups(ctx, &zpa.GetSCIMGroupsArgs{
    			IdpName: pulumi.StringRef("idp_name"),
    			Name:    pulumi.StringRef("Engineering"),
    		}, 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 engineering = Zpa.GetSCIMGroups.Invoke(new()
        {
            IdpName = "idp_name",
            Name = "Engineering",
        });
    
    });
    
    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.GetSCIMGroupsArgs;
    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 engineering = ZpaFunctions.getSCIMGroups(GetSCIMGroupsArgs.builder()
                .idpName("idp_name")
                .name("Engineering")
                .build());
    
        }
    }
    
    variables:
      engineering:
        fn::invoke:
          Function: zpa:getSCIMGroups
          Arguments:
            idpName: idp_name
            name: Engineering
    

    Using getSCIMGroups

    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 getSCIMGroups(args: GetSCIMGroupsArgs, opts?: InvokeOptions): Promise<GetSCIMGroupsResult>
    function getSCIMGroupsOutput(args: GetSCIMGroupsOutputArgs, opts?: InvokeOptions): Output<GetSCIMGroupsResult>
    def get_scim_groups(id: Optional[str] = None,
                        idp_id: Optional[int] = None,
                        idp_name: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetSCIMGroupsResult
    def get_scim_groups_output(id: Optional[pulumi.Input[str]] = None,
                        idp_id: Optional[pulumi.Input[int]] = None,
                        idp_name: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetSCIMGroupsResult]
    func GetSCIMGroups(ctx *Context, args *GetSCIMGroupsArgs, opts ...InvokeOption) (*GetSCIMGroupsResult, error)
    func GetSCIMGroupsOutput(ctx *Context, args *GetSCIMGroupsOutputArgs, opts ...InvokeOption) GetSCIMGroupsResultOutput

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

    public static class GetSCIMGroups 
    {
        public static Task<GetSCIMGroupsResult> InvokeAsync(GetSCIMGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetSCIMGroupsResult> Invoke(GetSCIMGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSCIMGroupsResult> getSCIMGroups(GetSCIMGroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: zpa:index/getSCIMGroups:getSCIMGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    IdpId int
    IdpName string
    Name string
    Id string
    IdpId int
    IdpName string
    Name string
    id String
    idpId Integer
    idpName String
    name String
    id string
    idpId number
    idpName string
    name string
    id str
    idp_id int
    idp_name str
    name str
    id String
    idpId Number
    idpName String
    name String

    getSCIMGroups Result

    The following output properties are available:

    CreationTime int
    IdpGroupId string
    ModifiedTime int
    Id string
    IdpId int
    IdpName string
    Name string
    CreationTime int
    IdpGroupId string
    ModifiedTime int
    Id string
    IdpId int
    IdpName string
    Name string
    creationTime Integer
    idpGroupId String
    modifiedTime Integer
    id String
    idpId Integer
    idpName String
    name String
    creationTime number
    idpGroupId string
    modifiedTime number
    id string
    idpId number
    idpName string
    name string
    creationTime Number
    idpGroupId String
    modifiedTime Number
    id String
    idpId Number
    idpName 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 v0.0.12 published on Tuesday, Jul 30, 2024 by Zscaler