1. Registry
  2. Packages
  3. Auth0 Provider
  4. API Docs
  5. getConnectionDirectorySynchronizedGroups
Viewing docs for Auth0 v3.53.0
published on Sunday, Sep 13, 2026 by Pulumi
auth0 logo auth0 logo
Viewing docs for Auth0 v3.53.0
published on Sunday, Sep 13, 2026 by Pulumi

    Data source to retrieve the selected synchronized groups for a connection’s directory provisioning configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as auth0 from "@pulumi/auth0";
    
    const myGroups = auth0.getConnectionDirectorySynchronizedGroups({
        connectionId: "con_xxxxxxxxxxxxxxxx",
    });
    
    import pulumi
    import pulumi_auth0 as auth0
    
    my_groups = auth0.get_connection_directory_synchronized_groups(connection_id="con_xxxxxxxxxxxxxxxx")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := auth0.GetConnectionDirectorySynchronizedGroups(ctx, &auth0.LookupConnectionDirectorySynchronizedGroupsArgs{
    			ConnectionId: "con_xxxxxxxxxxxxxxxx",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Auth0 = Pulumi.Auth0;
    
    return await Deployment.RunAsync(() => 
    {
        var myGroups = Auth0.GetConnectionDirectorySynchronizedGroups.Invoke(new()
        {
            ConnectionId = "con_xxxxxxxxxxxxxxxx",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.auth0.Auth0Functions;
    import com.pulumi.auth0.inputs.GetConnectionDirectorySynchronizedGroupsArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 myGroups = Auth0Functions.getConnectionDirectorySynchronizedGroups(GetConnectionDirectorySynchronizedGroupsArgs.builder()
                .connectionId("con_xxxxxxxxxxxxxxxx")
                .build());
    
        }
    }
    
    variables:
      myGroups:
        fn::invoke:
          function: auth0:getConnectionDirectorySynchronizedGroups
          arguments:
            connectionId: con_xxxxxxxxxxxxxxxx
    
    pulumi {
      required_providers {
        auth0 = {
          source = "pulumi/auth0"
        }
      }
    }
    
    data "auth0_getconnectiondirectorysynchronizedgroups" "myGroups" {
      connection_id = "con_xxxxxxxxxxxxxxxx"
    }
    

    Using getConnectionDirectorySynchronizedGroups

    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 getConnectionDirectorySynchronizedGroups(args: GetConnectionDirectorySynchronizedGroupsArgs, opts?: InvokeOptions): Promise<GetConnectionDirectorySynchronizedGroupsResult>
    function getConnectionDirectorySynchronizedGroupsOutput(args: GetConnectionDirectorySynchronizedGroupsOutputArgs, opts?: InvokeOutputOptions): Output<GetConnectionDirectorySynchronizedGroupsResult>
    def get_connection_directory_synchronized_groups(connection_id: Optional[str] = None,
                                                     query: Optional[str] = None,
                                                     opts: Optional[InvokeOptions] = None) -> GetConnectionDirectorySynchronizedGroupsResult
    def get_connection_directory_synchronized_groups_output(connection_id: pulumi.Input[Optional[str]] = None,
                                                     query: pulumi.Input[Optional[str]] = None,
                                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetConnectionDirectorySynchronizedGroupsResult]
    func LookupConnectionDirectorySynchronizedGroups(ctx *Context, args *LookupConnectionDirectorySynchronizedGroupsArgs, opts ...InvokeOption) (*LookupConnectionDirectorySynchronizedGroupsResult, error)
    func LookupConnectionDirectorySynchronizedGroupsOutput(ctx *Context, args *LookupConnectionDirectorySynchronizedGroupsOutputArgs, opts ...InvokeOption) LookupConnectionDirectorySynchronizedGroupsResultOutput

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

    public static class GetConnectionDirectorySynchronizedGroups 
    {
        public static Task<GetConnectionDirectorySynchronizedGroupsResult> InvokeAsync(GetConnectionDirectorySynchronizedGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionDirectorySynchronizedGroupsResult> Invoke(GetConnectionDirectorySynchronizedGroupsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionDirectorySynchronizedGroupsResult> Invoke(GetConnectionDirectorySynchronizedGroupsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetConnectionDirectorySynchronizedGroupsResult> getConnectionDirectorySynchronizedGroups(GetConnectionDirectorySynchronizedGroupsArgs args, InvokeOptions options)
    public static Output<GetConnectionDirectorySynchronizedGroupsResult> getConnectionDirectorySynchronizedGroups(GetConnectionDirectorySynchronizedGroupsArgs args, InvokeOptions options)
    public static Output<GetConnectionDirectorySynchronizedGroupsResult> getConnectionDirectorySynchronizedGroups(GetConnectionDirectorySynchronizedGroupsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: auth0:index/getConnectionDirectorySynchronizedGroups:getConnectionDirectorySynchronizedGroups
      arguments:
        # arguments dictionary
    data "auth0_get_connection_directory_synchronized_groups" "name" {
        # arguments
    }

    The following arguments are supported:

    ConnectionId string
    ID of the connection for which to manage synchronized groups.
    Query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    ConnectionId string
    ID of the connection for which to manage synchronized groups.
    Query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connection_id string
    ID of the connection for which to manage synchronized groups.
    query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connectionId String
    ID of the connection for which to manage synchronized groups.
    query String
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connectionId string
    ID of the connection for which to manage synchronized groups.
    query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connection_id str
    ID of the connection for which to manage synchronized groups.
    query str
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connectionId String
    ID of the connection for which to manage synchronized groups.
    query String
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.

    getConnectionDirectorySynchronizedGroups Result

    The following output properties are available:

    ConnectionId string
    ID of the connection for which to manage synchronized groups.
    GroupIds List<string>
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    Groups List<GetConnectionDirectorySynchronizedGroupsGroup>
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    Id string
    The provider-assigned unique ID for this managed resource.
    Query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    ConnectionId string
    ID of the connection for which to manage synchronized groups.
    GroupIds []string
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    Groups []GetConnectionDirectorySynchronizedGroupsGroup
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    Id string
    The provider-assigned unique ID for this managed resource.
    Query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connection_id string
    ID of the connection for which to manage synchronized groups.
    group_ids list(string)
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    groups list(object)
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    id string
    The provider-assigned unique ID for this managed resource.
    query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connectionId String
    ID of the connection for which to manage synchronized groups.
    groupIds List<String>
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    groups List<GetConnectionDirectorySynchronizedGroupsGroup>
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    id String
    The provider-assigned unique ID for this managed resource.
    query String
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connectionId string
    ID of the connection for which to manage synchronized groups.
    groupIds string[]
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    groups GetConnectionDirectorySynchronizedGroupsGroup[]
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    id string
    The provider-assigned unique ID for this managed resource.
    query string
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connection_id str
    ID of the connection for which to manage synchronized groups.
    group_ids Sequence[str]
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    groups Sequence[GetConnectionDirectorySynchronizedGroupsGroup]
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    id str
    The provider-assigned unique ID for this managed resource.
    query str
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.
    connectionId String
    ID of the connection for which to manage synchronized groups.
    groupIds List<String>
    IDs of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    groups List<Property Map>
    Details of the synchronized Google Workspace Directory groups. Limited to the groups matching query, when one is given.
    id String
    The provider-assigned unique ID for this managed resource.
    query String
    Filter the synchronized groups by a prefix search on a single field. Only name and email are searchable, and only as a prefix, so the term must take the form name:<value>* or email:<value>* (for example name:engineering*). Returns all synchronized groups when omitted.

    Supporting Types

    GetConnectionDirectorySynchronizedGroupsGroup

    DirectMembersCount int
    Number of direct members in the Google Workspace Directory group.
    Email string
    Google Workspace Directory group email.
    Id string
    Google Workspace Directory group ID.
    Name string
    Google Workspace Directory group name.
    DirectMembersCount int
    Number of direct members in the Google Workspace Directory group.
    Email string
    Google Workspace Directory group email.
    Id string
    Google Workspace Directory group ID.
    Name string
    Google Workspace Directory group name.
    direct_members_count number
    Number of direct members in the Google Workspace Directory group.
    email string
    Google Workspace Directory group email.
    id string
    Google Workspace Directory group ID.
    name string
    Google Workspace Directory group name.
    directMembersCount Integer
    Number of direct members in the Google Workspace Directory group.
    email String
    Google Workspace Directory group email.
    id String
    Google Workspace Directory group ID.
    name String
    Google Workspace Directory group name.
    directMembersCount number
    Number of direct members in the Google Workspace Directory group.
    email string
    Google Workspace Directory group email.
    id string
    Google Workspace Directory group ID.
    name string
    Google Workspace Directory group name.
    direct_members_count int
    Number of direct members in the Google Workspace Directory group.
    email str
    Google Workspace Directory group email.
    id str
    Google Workspace Directory group ID.
    name str
    Google Workspace Directory group name.
    directMembersCount Number
    Number of direct members in the Google Workspace Directory group.
    email String
    Google Workspace Directory group email.
    id String
    Google Workspace Directory group ID.
    name String
    Google Workspace Directory group name.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo auth0 logo
    Viewing docs for Auth0 v3.53.0
    published on Sunday, Sep 13, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial