1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getUserGroupMembers
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
cloudflare logo
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi

    Accepted Permissions

    • Account Settings Read
    • Account Settings Write
    • SCIM Provisioning

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleUserGroupMembers = cloudflare.getUserGroupMembers({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        userGroupId: "023e105f4ecef8ad9ca31a8372d0c353",
        direction: "asc",
        fuzzyEmail: "user@",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_user_group_members = cloudflare.get_user_group_members(account_id="023e105f4ecef8ad9ca31a8372d0c353",
        user_group_id="023e105f4ecef8ad9ca31a8372d0c353",
        direction="asc",
        fuzzy_email="user@")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.GetUserGroupMembers(ctx, &cloudflare.LookupUserGroupMembersArgs{
    			AccountId:   "023e105f4ecef8ad9ca31a8372d0c353",
    			UserGroupId: "023e105f4ecef8ad9ca31a8372d0c353",
    			Direction:   pulumi.StringRef("asc"),
    			FuzzyEmail:  pulumi.StringRef("user@"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleUserGroupMembers = Cloudflare.Index.GetUserGroupMembers.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            UserGroupId = "023e105f4ecef8ad9ca31a8372d0c353",
            Direction = "asc",
            FuzzyEmail = "user@",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetUserGroupMembersArgs;
    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 exampleUserGroupMembers = CloudflareFunctions.getUserGroupMembers(GetUserGroupMembersArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .userGroupId("023e105f4ecef8ad9ca31a8372d0c353")
                .direction("asc")
                .fuzzyEmail("user@")
                .build());
    
        }
    }
    
    variables:
      exampleUserGroupMembers:
        fn::invoke:
          function: cloudflare:getUserGroupMembers
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
            userGroupId: 023e105f4ecef8ad9ca31a8372d0c353
            direction: asc
            fuzzyEmail: user@
    

    Using getUserGroupMembers

    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 getUserGroupMembers(args: GetUserGroupMembersArgs, opts?: InvokeOptions): Promise<GetUserGroupMembersResult>
    function getUserGroupMembersOutput(args: GetUserGroupMembersOutputArgs, opts?: InvokeOptions): Output<GetUserGroupMembersResult>
    def get_user_group_members(account_id: Optional[str] = None,
                               direction: Optional[str] = None,
                               fuzzy_email: Optional[str] = None,
                               user_group_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetUserGroupMembersResult
    def get_user_group_members_output(account_id: Optional[pulumi.Input[str]] = None,
                               direction: Optional[pulumi.Input[str]] = None,
                               fuzzy_email: Optional[pulumi.Input[str]] = None,
                               user_group_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupMembersResult]
    func LookupUserGroupMembers(ctx *Context, args *LookupUserGroupMembersArgs, opts ...InvokeOption) (*LookupUserGroupMembersResult, error)
    func LookupUserGroupMembersOutput(ctx *Context, args *LookupUserGroupMembersOutputArgs, opts ...InvokeOption) LookupUserGroupMembersResultOutput

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

    public static class GetUserGroupMembers 
    {
        public static Task<GetUserGroupMembersResult> InvokeAsync(GetUserGroupMembersArgs args, InvokeOptions? opts = null)
        public static Output<GetUserGroupMembersResult> Invoke(GetUserGroupMembersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserGroupMembersResult> getUserGroupMembers(GetUserGroupMembersArgs args, InvokeOptions options)
    public static Output<GetUserGroupMembersResult> getUserGroupMembers(GetUserGroupMembersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getUserGroupMembers:getUserGroupMembers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Account identifier tag.
    UserGroupId string
    User Group identifier tag.
    Direction string
    The sort order of returned user group members by email. Available values: "asc", "desc".
    FuzzyEmail string
    A string used for filtering members by partial email match.
    AccountId string
    Account identifier tag.
    UserGroupId string
    User Group identifier tag.
    Direction string
    The sort order of returned user group members by email. Available values: "asc", "desc".
    FuzzyEmail string
    A string used for filtering members by partial email match.
    accountId String
    Account identifier tag.
    userGroupId String
    User Group identifier tag.
    direction String
    The sort order of returned user group members by email. Available values: "asc", "desc".
    fuzzyEmail String
    A string used for filtering members by partial email match.
    accountId string
    Account identifier tag.
    userGroupId string
    User Group identifier tag.
    direction string
    The sort order of returned user group members by email. Available values: "asc", "desc".
    fuzzyEmail string
    A string used for filtering members by partial email match.
    account_id str
    Account identifier tag.
    user_group_id str
    User Group identifier tag.
    direction str
    The sort order of returned user group members by email. Available values: "asc", "desc".
    fuzzy_email str
    A string used for filtering members by partial email match.
    accountId String
    Account identifier tag.
    userGroupId String
    User Group identifier tag.
    direction String
    The sort order of returned user group members by email. Available values: "asc", "desc".
    fuzzyEmail String
    A string used for filtering members by partial email match.

    getUserGroupMembers Result

    The following output properties are available:

    AccountId string
    Account identifier tag.
    Direction string
    The sort order of returned user group members by email. Available values: "asc", "desc".
    Id string
    User Group identifier tag.
    Members List<GetUserGroupMembersMember>
    UserGroupId string
    User Group identifier tag.
    FuzzyEmail string
    A string used for filtering members by partial email match.
    AccountId string
    Account identifier tag.
    Direction string
    The sort order of returned user group members by email. Available values: "asc", "desc".
    Id string
    User Group identifier tag.
    Members []GetUserGroupMembersMember
    UserGroupId string
    User Group identifier tag.
    FuzzyEmail string
    A string used for filtering members by partial email match.
    accountId String
    Account identifier tag.
    direction String
    The sort order of returned user group members by email. Available values: "asc", "desc".
    id String
    User Group identifier tag.
    members List<GetUserGroupMembersMember>
    userGroupId String
    User Group identifier tag.
    fuzzyEmail String
    A string used for filtering members by partial email match.
    accountId string
    Account identifier tag.
    direction string
    The sort order of returned user group members by email. Available values: "asc", "desc".
    id string
    User Group identifier tag.
    members GetUserGroupMembersMember[]
    userGroupId string
    User Group identifier tag.
    fuzzyEmail string
    A string used for filtering members by partial email match.
    account_id str
    Account identifier tag.
    direction str
    The sort order of returned user group members by email. Available values: "asc", "desc".
    id str
    User Group identifier tag.
    members Sequence[GetUserGroupMembersMember]
    user_group_id str
    User Group identifier tag.
    fuzzy_email str
    A string used for filtering members by partial email match.
    accountId String
    Account identifier tag.
    direction String
    The sort order of returned user group members by email. Available values: "asc", "desc".
    id String
    User Group identifier tag.
    members List<Property Map>
    userGroupId String
    User Group identifier tag.
    fuzzyEmail String
    A string used for filtering members by partial email match.

    Supporting Types

    GetUserGroupMembersMember

    Email string
    The contact email address of the user.
    Id string
    User Group identifier tag.
    Status string
    The member's status in the account. Available values: "accepted", "pending".
    Email string
    The contact email address of the user.
    Id string
    User Group identifier tag.
    Status string
    The member's status in the account. Available values: "accepted", "pending".
    email String
    The contact email address of the user.
    id String
    User Group identifier tag.
    status String
    The member's status in the account. Available values: "accepted", "pending".
    email string
    The contact email address of the user.
    id string
    User Group identifier tag.
    status string
    The member's status in the account. Available values: "accepted", "pending".
    email str
    The contact email address of the user.
    id str
    User Group identifier tag.
    status str
    The member's status in the account. Available values: "accepted", "pending".
    email String
    The contact email address of the user.
    id String
    User Group identifier tag.
    status String
    The member's status in the account. Available values: "accepted", "pending".

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.15.0
    published on Saturday, May 2, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.