1. Packages
  2. Zscaler Private Access (ZPA)
  3. API Docs
  4. getSCIMAttributeHeader
Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler

zpa.getSCIMAttributeHeader

Start a Neo task
Explain and create a zpa.getSCIMAttributeHeader resource
zpa logo
Zscaler Private Access v1.0.2 published on Friday, Jun 20, 2025 by Zscaler

    Use the zpa_scim_attribute_header data source to get information about a SCIM attribute from an Identity Provider (IdP). This data source can then be referenced in an Access Policy, Timeout policy, Forwarding Policy, Inspection Policy or Inspection 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";
    
    const givenName = zpa.getSCIMAttributeHeader({
        idpName: "IdP_Name",
        name: "name.givenName",
    });
    const familyName = zpa.getSCIMAttributeHeader({
        idpName: "IdP_Name",
        name: "name.familyName",
    });
    
    import pulumi
    import pulumi_zpa as zpa
    
    given_name = zpa.get_scim_attribute_header(idp_name="IdP_Name",
        name="name.givenName")
    family_name = zpa.get_scim_attribute_header(idp_name="IdP_Name",
        name="name.familyName")
    
    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.GetSCIMAttributeHeader(ctx, &zpa.GetSCIMAttributeHeaderArgs{
    			IdpName: pulumi.StringRef("IdP_Name"),
    			Name:    pulumi.StringRef("name.givenName"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = zpa.GetSCIMAttributeHeader(ctx, &zpa.GetSCIMAttributeHeaderArgs{
    			IdpName: pulumi.StringRef("IdP_Name"),
    			Name:    pulumi.StringRef("name.familyName"),
    		}, 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 givenName = Zpa.GetSCIMAttributeHeader.Invoke(new()
        {
            IdpName = "IdP_Name",
            Name = "name.givenName",
        });
    
        var familyName = Zpa.GetSCIMAttributeHeader.Invoke(new()
        {
            IdpName = "IdP_Name",
            Name = "name.familyName",
        });
    
    });
    
    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.GetSCIMAttributeHeaderArgs;
    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 givenName = ZpaFunctions.getSCIMAttributeHeader(GetSCIMAttributeHeaderArgs.builder()
                .idpName("IdP_Name")
                .name("name.givenName")
                .build());
    
            final var familyName = ZpaFunctions.getSCIMAttributeHeader(GetSCIMAttributeHeaderArgs.builder()
                .idpName("IdP_Name")
                .name("name.familyName")
                .build());
    
        }
    }
    
    variables:
      givenName:
        fn::invoke:
          function: zpa:getSCIMAttributeHeader
          arguments:
            idpName: IdP_Name
            name: name.givenName
      familyName:
        fn::invoke:
          function: zpa:getSCIMAttributeHeader
          arguments:
            idpName: IdP_Name
            name: name.familyName
    

    Using getSCIMAttributeHeader

    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 getSCIMAttributeHeader(args: GetSCIMAttributeHeaderArgs, opts?: InvokeOptions): Promise<GetSCIMAttributeHeaderResult>
    function getSCIMAttributeHeaderOutput(args: GetSCIMAttributeHeaderOutputArgs, opts?: InvokeOptions): Output<GetSCIMAttributeHeaderResult>
    def get_scim_attribute_header(idp_id: Optional[str] = None,
                                  idp_name: Optional[str] = None,
                                  name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSCIMAttributeHeaderResult
    def get_scim_attribute_header_output(idp_id: Optional[pulumi.Input[str]] = None,
                                  idp_name: Optional[pulumi.Input[str]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetSCIMAttributeHeaderResult]
    func GetSCIMAttributeHeader(ctx *Context, args *GetSCIMAttributeHeaderArgs, opts ...InvokeOption) (*GetSCIMAttributeHeaderResult, error)
    func GetSCIMAttributeHeaderOutput(ctx *Context, args *GetSCIMAttributeHeaderOutputArgs, opts ...InvokeOption) GetSCIMAttributeHeaderResultOutput

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

    public static class GetSCIMAttributeHeader 
    {
        public static Task<GetSCIMAttributeHeaderResult> InvokeAsync(GetSCIMAttributeHeaderArgs args, InvokeOptions? opts = null)
        public static Output<GetSCIMAttributeHeaderResult> Invoke(GetSCIMAttributeHeaderInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSCIMAttributeHeaderResult> getSCIMAttributeHeader(GetSCIMAttributeHeaderArgs args, InvokeOptions options)
    public static Output<GetSCIMAttributeHeaderResult> getSCIMAttributeHeader(GetSCIMAttributeHeaderArgs args, InvokeOptions options)
    
    fn::invoke:
      function: zpa:index/getSCIMAttributeHeader:getSCIMAttributeHeader
      arguments:
        # arguments dictionary

    The following arguments are supported:

    IdpId string
    IdpName string
    Name string
    IdpId string
    IdpName string
    Name string
    idpId String
    idpName String
    name String
    idpId string
    idpName string
    name string
    idp_id str
    idp_name str
    name str
    idpId String
    idpName String
    name String

    getSCIMAttributeHeader Result

    The following output properties are available:

    CanonicalValues List<string>
    CaseSensitive bool
    CreationTime string
    DataType string
    Description string
    Id string
    ModifiedTime string
    Modifiedby string
    Multivalued bool
    Mutability string
    Required bool
    Returned string
    SchemaUri string
    Uniqueness bool
    Values List<string>
    IdpId string
    IdpName string
    Name string
    CanonicalValues []string
    CaseSensitive bool
    CreationTime string
    DataType string
    Description string
    Id string
    ModifiedTime string
    Modifiedby string
    Multivalued bool
    Mutability string
    Required bool
    Returned string
    SchemaUri string
    Uniqueness bool
    Values []string
    IdpId string
    IdpName string
    Name string
    canonicalValues List<String>
    caseSensitive Boolean
    creationTime String
    dataType String
    description String
    id String
    modifiedTime String
    modifiedby String
    multivalued Boolean
    mutability String
    required Boolean
    returned String
    schemaUri String
    uniqueness Boolean
    values List<String>
    idpId String
    idpName String
    name String
    canonicalValues string[]
    caseSensitive boolean
    creationTime string
    dataType string
    description string
    id string
    modifiedTime string
    modifiedby string
    multivalued boolean
    mutability string
    required boolean
    returned string
    schemaUri string
    uniqueness boolean
    values string[]
    idpId string
    idpName string
    name string
    canonicalValues List<String>
    caseSensitive Boolean
    creationTime String
    dataType String
    description String
    id String
    modifiedTime String
    modifiedby String
    multivalued Boolean
    mutability String
    required Boolean
    returned String
    schemaUri String
    uniqueness Boolean
    values List<String>
    idpId String
    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 v1.0.2 published on Friday, Jun 20, 2025 by Zscaler
      Meet Neo: Your AI Platform Teammate