1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getGroup
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A Group is a powerful tool for permissions and user management on Files.com. Users can belong to multiple groups.

    All permissions can be managed via Groups, and Groups can also be synced to your identity platform via LDAP or SCIM.

    Files.com’s Group Admin feature allows you to define Group Admins, who then have access to add and remove users within their groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleGroup = filescom.getGroup({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_group = filescom.get_group(id=1)
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.GetGroup(ctx, &filescom.LookupGroupArgs{
    			Id: 1,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleGroup = Filescom.GetGroup.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetGroupArgs;
    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 exampleGroup = FilescomFunctions.getGroup(GetGroupArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleGroup:
        fn::invoke:
          function: filescom:getGroup
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getgroup" "exampleGroup" {
      id = 1
    }
    

    Using getGroup

    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 getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
    function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOutputOptions): Output<GetGroupResult>
    def get_group(id: Optional[int] = None,
                  opts: Optional[InvokeOptions] = None) -> GetGroupResult
    def get_group_output(id: pulumi.Input[Optional[int]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetGroupResult]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
    func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

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

    public static class GetGroup 
    {
        public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
    public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
    public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getGroup:getGroup
      arguments:
        # arguments dictionary
    data "filescom_get_group" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Group ID
    Id int
    Group ID
    id number
    Group ID
    id Integer
    Group ID
    id number
    Group ID
    id int
    Group ID
    id Number
    Group ID

    getGroup Result

    The following output properties are available:

    AdminIds string
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    AllowedIps string
    A list of allowed IPs if applicable. Newline delimited
    DavPermission bool
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    DesktopConfigurationProfileId int
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    FtpPermission bool
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    Id int
    Group ID
    IntegrationCentricProfileId int
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    Name string
    Group name
    Notes string
    Notes about this group
    RestapiPermission bool
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    SftpPermission bool
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    SiteId int
    Site ID
    UserIds string
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    Usernames string
    Comma-delimited list of usernames who belong to this group (separated by commas)
    WorkspaceId int
    Workspace ID
    AdminIds string
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    AllowedIps string
    A list of allowed IPs if applicable. Newline delimited
    DavPermission bool
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    DesktopConfigurationProfileId int
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    FtpPermission bool
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    Id int
    Group ID
    IntegrationCentricProfileId int
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    Name string
    Group name
    Notes string
    Notes about this group
    RestapiPermission bool
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    SftpPermission bool
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    SiteId int
    Site ID
    UserIds string
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    Usernames string
    Comma-delimited list of usernames who belong to this group (separated by commas)
    WorkspaceId int
    Workspace ID
    admin_ids string
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    ai_assistant_personality_id number
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    allowed_ips string
    A list of allowed IPs if applicable. Newline delimited
    dav_permission bool
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    desktop_configuration_profile_id number
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    ftp_permission bool
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    id number
    Group ID
    integration_centric_profile_id number
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    name string
    Group name
    notes string
    Notes about this group
    restapi_permission bool
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    sftp_permission bool
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    site_id number
    Site ID
    user_ids string
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    usernames string
    Comma-delimited list of usernames who belong to this group (separated by commas)
    workspace_id number
    Workspace ID
    adminIds String
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    aiAssistantPersonalityId Integer
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    allowedIps String
    A list of allowed IPs if applicable. Newline delimited
    davPermission Boolean
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    desktopConfigurationProfileId Integer
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    ftpPermission Boolean
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    id Integer
    Group ID
    integrationCentricProfileId Integer
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    name String
    Group name
    notes String
    Notes about this group
    restapiPermission Boolean
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    sftpPermission Boolean
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    siteId Integer
    Site ID
    userIds String
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    usernames String
    Comma-delimited list of usernames who belong to this group (separated by commas)
    workspaceId Integer
    Workspace ID
    adminIds string
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    aiAssistantPersonalityId number
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    allowedIps string
    A list of allowed IPs if applicable. Newline delimited
    davPermission boolean
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    desktopConfigurationProfileId number
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    ftpPermission boolean
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    id number
    Group ID
    integrationCentricProfileId number
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    name string
    Group name
    notes string
    Notes about this group
    restapiPermission boolean
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    sftpPermission boolean
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    siteId number
    Site ID
    userIds string
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    usernames string
    Comma-delimited list of usernames who belong to this group (separated by commas)
    workspaceId number
    Workspace ID
    admin_ids str
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    ai_assistant_personality_id int
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    allowed_ips str
    A list of allowed IPs if applicable. Newline delimited
    dav_permission bool
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    desktop_configuration_profile_id int
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    ftp_permission bool
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    id int
    Group ID
    integration_centric_profile_id int
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    name str
    Group name
    notes str
    Notes about this group
    restapi_permission bool
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    sftp_permission bool
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    site_id int
    Site ID
    user_ids str
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    usernames str
    Comma-delimited list of usernames who belong to this group (separated by commas)
    workspace_id int
    Workspace ID
    adminIds String
    Comma-delimited list of user IDs who are group administrators (separated by commas)
    aiAssistantPersonalityId Number
    AI Assistant Personality ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user or Partner assignment overrides it.
    allowedIps String
    A list of allowed IPs if applicable. Newline delimited
    davPermission Boolean
    If true, users in this group can use WebDAV to login. This will override a false value of davPermission on the user level.
    desktopConfigurationProfileId Number
    Desktop Configuration Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    ftpPermission Boolean
    If true, users in this group can use FTP to login. This will override a false value of ftpPermission on the user level.
    id Number
    Group ID
    integrationCentricProfileId Number
    Integration Centric Profile ID assigned to this Group, if any. Users in the Group inherit it unless a direct per-user assignment overrides it.
    name String
    Group name
    notes String
    Notes about this group
    restapiPermission Boolean
    If true, users in this group can use the REST API to login. This will override a false value of restapiPermission on the user level.
    sftpPermission Boolean
    If true, users in this group can use SFTP to login. This will override a false value of sftpPermission on the user level.
    siteId Number
    Site ID
    userIds String
    Comma-delimited list of user IDs who belong to this group (separated by commas)
    usernames String
    Comma-delimited list of usernames who belong to this group (separated by commas)
    workspaceId Number
    Workspace ID

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial