1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getSAMLAttribute
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
zpa logo
Zscaler Private Access v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler

    Use the zpa_saml_attribute data source to get information about a SAML Attributes 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.

    NOTE: To ensure consistent search results across data sources, please avoid using multiple spaces or special characters in your search queries.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    // ZPA SAML Attribute Data Source
    const emailUserSso = zpa.getSAMLAttribute({
        name: "Email_User SSO",
        idpName: "idp_name",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    # ZPA SAML Attribute Data Source
    email_user_sso = zpa.get_saml_attribute(name="Email_User SSO",
        idp_name="idp_name")
    
    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 {
    		// ZPA SAML Attribute Data Source
    		_, err := zpa.GetSAMLAttribute(ctx, &zpa.GetSAMLAttributeArgs{
    			Name:    pulumi.StringRef("Email_User SSO"),
    			IdpName: pulumi.StringRef("idp_name"),
    		}, 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(() => 
    {
        // ZPA SAML Attribute Data Source
        var emailUserSso = Zpa.GetSAMLAttribute.Invoke(new()
        {
            Name = "Email_User SSO",
            IdpName = "idp_name",
        });
    
    });
    
    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.GetSAMLAttributeArgs;
    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) {
            // ZPA SAML Attribute Data Source
            final var emailUserSso = ZpaFunctions.getSAMLAttribute(GetSAMLAttributeArgs.builder()
                .name("Email_User SSO")
                .idpName("idp_name")
                .build());
    
        }
    }
    
    variables:
      # ZPA SAML Attribute Data Source
      emailUserSso:
        fn::invoke:
          function: zpa:getSAMLAttribute
          arguments:
            name: Email_User SSO
            idpName: idp_name
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zpa from "@bdzscaler/pulumi-zpa";
    
    // ZPA SAML Attribute Data Source
    const department = zpa.getSAMLAttribute({
        name: "DepartmentName_IdP_Name_Users",
        idpName: "idp_name",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    # ZPA SAML Attribute Data Source
    department = zpa.get_saml_attribute(name="DepartmentName_IdP_Name_Users",
        idp_name="idp_name")
    
    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 {
    		// ZPA SAML Attribute Data Source
    		_, err := zpa.GetSAMLAttribute(ctx, &zpa.GetSAMLAttributeArgs{
    			Name:    pulumi.StringRef("DepartmentName_IdP_Name_Users"),
    			IdpName: pulumi.StringRef("idp_name"),
    		}, 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(() => 
    {
        // ZPA SAML Attribute Data Source
        var department = Zpa.GetSAMLAttribute.Invoke(new()
        {
            Name = "DepartmentName_IdP_Name_Users",
            IdpName = "idp_name",
        });
    
    });
    
    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.GetSAMLAttributeArgs;
    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) {
            // ZPA SAML Attribute Data Source
            final var department = ZpaFunctions.getSAMLAttribute(GetSAMLAttributeArgs.builder()
                .name("DepartmentName_IdP_Name_Users")
                .idpName("idp_name")
                .build());
    
        }
    }
    
    variables:
      # ZPA SAML Attribute Data Source
      department:
        fn::invoke:
          function: zpa:getSAMLAttribute
          arguments:
            name: DepartmentName_IdP_Name_Users
            idpName: idp_name
    

    Using getSAMLAttribute

    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 getSAMLAttribute(args: GetSAMLAttributeArgs, opts?: InvokeOptions): Promise<GetSAMLAttributeResult>
    function getSAMLAttributeOutput(args: GetSAMLAttributeOutputArgs, opts?: InvokeOptions): Output<GetSAMLAttributeResult>
    def get_saml_attribute(id: Optional[str] = None,
                           idp_name: Optional[str] = None,
                           name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSAMLAttributeResult
    def get_saml_attribute_output(id: Optional[pulumi.Input[str]] = None,
                           idp_name: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSAMLAttributeResult]
    func GetSAMLAttribute(ctx *Context, args *GetSAMLAttributeArgs, opts ...InvokeOption) (*GetSAMLAttributeResult, error)
    func GetSAMLAttributeOutput(ctx *Context, args *GetSAMLAttributeOutputArgs, opts ...InvokeOption) GetSAMLAttributeResultOutput

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

    public static class GetSAMLAttribute 
    {
        public static Task<GetSAMLAttributeResult> InvokeAsync(GetSAMLAttributeArgs args, InvokeOptions? opts = null)
        public static Output<GetSAMLAttributeResult> Invoke(GetSAMLAttributeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSAMLAttributeResult> getSAMLAttribute(GetSAMLAttributeArgs args, InvokeOptions options)
    public static Output<GetSAMLAttributeResult> getSAMLAttribute(GetSAMLAttributeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getSAMLAttribute:getSAMLAttribute
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    IdpName string
    Name string
    Id string
    IdpName string
    Name string
    id String
    idpName String
    name String
    id string
    idpName string
    name string
    id str
    idp_name str
    name str
    id String
    idpName String
    name String

    getSAMLAttribute Result

    The following output properties are available:

    CreationTime string
    Id string
    IdpId string
    ModifiedTime string
    Modifiedby string
    Name string
    SamlName string
    UserAttribute bool
    IdpName string
    CreationTime string
    Id string
    IdpId string
    ModifiedTime string
    Modifiedby string
    Name string
    SamlName string
    UserAttribute bool
    IdpName string
    creationTime String
    id String
    idpId String
    modifiedTime String
    modifiedby String
    name String
    samlName String
    userAttribute Boolean
    idpName String
    creationTime string
    id string
    idpId string
    modifiedTime string
    modifiedby string
    name string
    samlName string
    userAttribute boolean
    idpName string
    creationTime String
    id String
    idpId String
    modifiedTime String
    modifiedby String
    name String
    samlName String
    userAttribute Boolean
    idpName 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 v1.0.3 published on Wednesday, Jan 21, 2026 by Zscaler
      Meet Neo: Your AI Platform Teammate