Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getPermission
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.getPermission

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A Permission object represents a grant of access permission on a specific Path to a User or Group.

    They can be optionally recursive or nonrecursive into the subfolders of that path.

    A Permission may be applied to a User or a Group, but not both at once.

    The following table sets forth the available Permission types:

    | Permission | Access Level Granted | Automatically Also Includes/Implies Permissions |

    |—|———–|———————|

    | admin | Able to manage Folder Behaviors, Permissions, and Notifications for the folder. Also grants all other permissions. | bundle, full, writeonly, readonly, list, history |

    | bundle | Able to share files and folders via a Bundle (share link). | readonly, list |

    | full | Able to read, write, move, delete, and rename files and folders. Also grants the ability to overwrite files upon upload. | writeonly, readonly, list |

    | history | Able to view the history of files and folders and to create email notifications for themselves. | list |

    | list | Able to list files and folders, but not download. | none |

    | readonly | Able to list, preview, and download files and folders. | list |

    | readonlySiteAdmin | Able to behave as a read-only Site Admin on a given child site. Only applies to child sites. | readonly, list, history |

    | siteAdmin | Able to behave as a Site Admin on a given child site. Only applies to child sites. | bundle, full, writeonly, readonly, list, history |

    | writeonly | Able to upload files, create folders and list subfolders the user has write permission to. | none |

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const examplePermission = filescom.getPermission({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_permission = filescom.get_permission(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.GetPermission(ctx, &filescom.LookupPermissionArgs{
			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 examplePermission = Filescom.GetPermission.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.GetPermissionArgs;
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 examplePermission = FilescomFunctions.getPermission(GetPermissionArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  examplePermission:
    fn::invoke:
      function: filescom:getPermission
      arguments:
        id: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

data "filescom_getpermission" "examplePermission" {
  id = 1
}

    Using getPermission

    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 getPermission(args: GetPermissionArgs, opts?: InvokeOptions): Promise<GetPermissionResult>
function getPermissionOutput(args: GetPermissionOutputArgs, opts?: InvokeOutputOptions): Output<GetPermissionResult>
    def get_permission(id: Optional[int] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPermissionResult
def get_permission_output(id: pulumi.Input[Optional[int]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetPermissionResult]
    func LookupPermission(ctx *Context, args *LookupPermissionArgs, opts ...InvokeOption) (*LookupPermissionResult, error)
func LookupPermissionOutput(ctx *Context, args *LookupPermissionOutputArgs, opts ...InvokeOption) LookupPermissionResultOutput

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

    public static class GetPermission 
{
    public static Task<GetPermissionResult> InvokeAsync(GetPermissionArgs args, InvokeOptions? opts = null)
    public static Output<GetPermissionResult> Invoke(GetPermissionInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPermissionResult> Invoke(GetPermissionInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPermissionResult> getPermission(GetPermissionArgs args, InvokeOptions options)
public static Output<GetPermissionResult> getPermission(GetPermissionArgs args, InvokeOptions options)
public static Output<GetPermissionResult> getPermission(GetPermissionArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getPermission:getPermission
  arguments:
    # arguments dictionary
    data "filescom_get_permission" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    Permission ID
    Id int
    Permission ID
    id number
    Permission ID
    id Integer
    Permission ID
    id number
    Permission ID
    id int
    Permission ID
    id Number
    Permission ID

    getPermission Result

    The following output properties are available:

    GroupId int
    Group ID
    GroupIds List<int>
    Group IDs when this permission requires multiple groups
    GroupName string
    Group name (if applicable)
    GroupNames List<string>
    Group names when this permission requires multiple groups
    Id int
    Permission ID
    PartnerId int
    Partner ID (if applicable)
    PartnerName string
    Partner name (if applicable)
    Path string
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Permission string
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    Recursive bool
    Recursive: does this permission apply to subfolders?
    SiteId int
    Site ID
    UserId int
    User ID
    Username string
    Username (if applicable)
    GroupId int
    Group ID
    GroupIds []int
    Group IDs when this permission requires multiple groups
    GroupName string
    Group name (if applicable)
    GroupNames []string
    Group names when this permission requires multiple groups
    Id int
    Permission ID
    PartnerId int
    Partner ID (if applicable)
    PartnerName string
    Partner name (if applicable)
    Path string
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Permission string
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    Recursive bool
    Recursive: does this permission apply to subfolders?
    SiteId int
    Site ID
    UserId int
    User ID
    Username string
    Username (if applicable)
    group_id number
    Group ID
    group_ids list(number)
    Group IDs when this permission requires multiple groups
    group_name string
    Group name (if applicable)
    group_names list(string)
    Group names when this permission requires multiple groups
    id number
    Permission ID
    partner_id number
    Partner ID (if applicable)
    partner_name string
    Partner name (if applicable)
    path string
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission string
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    recursive bool
    Recursive: does this permission apply to subfolders?
    site_id number
    Site ID
    user_id number
    User ID
    username string
    Username (if applicable)
    groupId Integer
    Group ID
    groupIds List<Integer>
    Group IDs when this permission requires multiple groups
    groupName String
    Group name (if applicable)
    groupNames List<String>
    Group names when this permission requires multiple groups
    id Integer
    Permission ID
    partnerId Integer
    Partner ID (if applicable)
    partnerName String
    Partner name (if applicable)
    path String
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission String
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    recursive Boolean
    Recursive: does this permission apply to subfolders?
    siteId Integer
    Site ID
    userId Integer
    User ID
    username String
    Username (if applicable)
    groupId number
    Group ID
    groupIds number[]
    Group IDs when this permission requires multiple groups
    groupName string
    Group name (if applicable)
    groupNames string[]
    Group names when this permission requires multiple groups
    id number
    Permission ID
    partnerId number
    Partner ID (if applicable)
    partnerName string
    Partner name (if applicable)
    path string
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission string
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    recursive boolean
    Recursive: does this permission apply to subfolders?
    siteId number
    Site ID
    userId number
    User ID
    username string
    Username (if applicable)
    group_id int
    Group ID
    group_ids Sequence[int]
    Group IDs when this permission requires multiple groups
    group_name str
    Group name (if applicable)
    group_names Sequence[str]
    Group names when this permission requires multiple groups
    id int
    Permission ID
    partner_id int
    Partner ID (if applicable)
    partner_name str
    Partner name (if applicable)
    path str
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission str
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    recursive bool
    Recursive: does this permission apply to subfolders?
    site_id int
    Site ID
    user_id int
    User ID
    username str
    Username (if applicable)
    groupId Number
    Group ID
    groupIds List<Number>
    Group IDs when this permission requires multiple groups
    groupName String
    Group name (if applicable)
    groupNames List<String>
    Group names when this permission requires multiple groups
    id Number
    Permission ID
    partnerId Number
    Partner ID (if applicable)
    partnerName String
    Partner name (if applicable)
    path String
    Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    permission String
    Permission type. See the table referenced in the documentation for an explanation of each permission.
    recursive Boolean
    Recursive: does this permission apply to subfolders?
    siteId Number
    Site ID
    userId Number
    User ID
    username String
    Username (if applicable)

    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
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial