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

filescom.getPartner

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

    A Partner is a first-class entity that cleanly represents an external organization, enables delegated administration, and enforces strict boundaries.

    Example Usage

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

const examplePartner = filescom.getPartner({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_partner = filescom.get_partner(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.GetPartner(ctx, &filescom.LookupPartnerArgs{
			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 examplePartner = Filescom.GetPartner.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.GetPartnerArgs;
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 examplePartner = FilescomFunctions.getPartner(GetPartnerArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  examplePartner:
    fn::invoke:
      function: filescom:getPartner
      arguments:
        id: 1

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

data "filescom_getpartner" "examplePartner" {
  id = 1
}

    Using getPartner

    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 getPartner(args: GetPartnerArgs, opts?: InvokeOptions): Promise<GetPartnerResult>
function getPartnerOutput(args: GetPartnerOutputArgs, opts?: InvokeOutputOptions): Output<GetPartnerResult>
    def get_partner(id: Optional[int] = None,
                opts: Optional[InvokeOptions] = None) -> GetPartnerResult
def get_partner_output(id: pulumi.Input[Optional[int]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetPartnerResult]
    func LookupPartner(ctx *Context, args *LookupPartnerArgs, opts ...InvokeOption) (*LookupPartnerResult, error)
func LookupPartnerOutput(ctx *Context, args *LookupPartnerOutputArgs, opts ...InvokeOption) LookupPartnerResultOutput

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

    public static class GetPartner 
{
    public static Task<GetPartnerResult> InvokeAsync(GetPartnerArgs args, InvokeOptions? opts = null)
    public static Output<GetPartnerResult> Invoke(GetPartnerInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetPartnerResult> Invoke(GetPartnerInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetPartnerResult> getPartner(GetPartnerArgs args, InvokeOptions options)
public static Output<GetPartnerResult> getPartner(GetPartnerArgs args, InvokeOptions options)
public static Output<GetPartnerResult> getPartner(GetPartnerArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getPartner:getPartner
  arguments:
    # arguments dictionary
    data "filescom_get_partner" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    The unique ID of the Partner.
    Id int
    The unique ID of the Partner.
    id number
    The unique ID of the Partner.
    id Integer
    The unique ID of the Partner.
    id number
    The unique ID of the Partner.
    id int
    The unique ID of the Partner.
    id Number
    The unique ID of the Partner.

    getPartner Result

    The following output properties are available:

    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    AllowBypassing2faPolicies bool
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    AllowCredentialChanges bool
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    AllowProvidingGpgKeys bool
    Allow Partner Admins to provide GPG keys.
    AllowUserCreation bool
    Allow Partner Admins to create users.
    AllowedIps string
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    CcEmailsToResponsibleParty bool
    When true, emails sent to Partner users are copied to the responsible User or Group.
    Id int
    The unique ID of the Partner.
    Name string
    The name of the Partner.
    Notes string
    Notes about this Partner.
    PartnerAdminIds List<int>
    Array of User IDs that are Partner Admins for this Partner.
    PartnerChannelTemplateId int
    ID of the Partner Channel Template assigned to this Partner.
    PartnershipRole string
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    ResponsibleGroupId int
    ID of the Group responsible for this Partner.
    ResponsibleUserId int
    ID of the User responsible for this Partner.
    RootFolder string
    The root folder path for this Partner.
    ShowPartnerChannelHomePage bool
    Show Partner users a simplified home page built from this Partner's Channels.
    Tags string
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    UserIds List<int>
    Array of User IDs that belong to this Partner.
    WorkspaceId int
    ID of the Workspace associated with this Partner.
    AiAssistantPersonalityId int
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    AllowBypassing2faPolicies bool
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    AllowCredentialChanges bool
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    AllowProvidingGpgKeys bool
    Allow Partner Admins to provide GPG keys.
    AllowUserCreation bool
    Allow Partner Admins to create users.
    AllowedIps string
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    CcEmailsToResponsibleParty bool
    When true, emails sent to Partner users are copied to the responsible User or Group.
    Id int
    The unique ID of the Partner.
    Name string
    The name of the Partner.
    Notes string
    Notes about this Partner.
    PartnerAdminIds []int
    Array of User IDs that are Partner Admins for this Partner.
    PartnerChannelTemplateId int
    ID of the Partner Channel Template assigned to this Partner.
    PartnershipRole string
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    ResponsibleGroupId int
    ID of the Group responsible for this Partner.
    ResponsibleUserId int
    ID of the User responsible for this Partner.
    RootFolder string
    The root folder path for this Partner.
    ShowPartnerChannelHomePage bool
    Show Partner users a simplified home page built from this Partner's Channels.
    Tags string
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    UserIds []int
    Array of User IDs that belong to this Partner.
    WorkspaceId int
    ID of the Workspace associated with this Partner.
    ai_assistant_personality_id number
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    allow_bypassing2fa_policies bool
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    allow_credential_changes bool
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    allow_providing_gpg_keys bool
    Allow Partner Admins to provide GPG keys.
    allow_user_creation bool
    Allow Partner Admins to create users.
    allowed_ips string
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    cc_emails_to_responsible_party bool
    When true, emails sent to Partner users are copied to the responsible User or Group.
    id number
    The unique ID of the Partner.
    name string
    The name of the Partner.
    notes string
    Notes about this Partner.
    partner_admin_ids list(number)
    Array of User IDs that are Partner Admins for this Partner.
    partner_channel_template_id number
    ID of the Partner Channel Template assigned to this Partner.
    partnership_role string
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    responsible_group_id number
    ID of the Group responsible for this Partner.
    responsible_user_id number
    ID of the User responsible for this Partner.
    root_folder string
    The root folder path for this Partner.
    show_partner_channel_home_page bool
    Show Partner users a simplified home page built from this Partner's Channels.
    tags string
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    user_ids list(number)
    Array of User IDs that belong to this Partner.
    workspace_id number
    ID of the Workspace associated with this Partner.
    aiAssistantPersonalityId Integer
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    allowBypassing2faPolicies Boolean
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    allowCredentialChanges Boolean
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    allowProvidingGpgKeys Boolean
    Allow Partner Admins to provide GPG keys.
    allowUserCreation Boolean
    Allow Partner Admins to create users.
    allowedIps String
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    ccEmailsToResponsibleParty Boolean
    When true, emails sent to Partner users are copied to the responsible User or Group.
    id Integer
    The unique ID of the Partner.
    name String
    The name of the Partner.
    notes String
    Notes about this Partner.
    partnerAdminIds List<Integer>
    Array of User IDs that are Partner Admins for this Partner.
    partnerChannelTemplateId Integer
    ID of the Partner Channel Template assigned to this Partner.
    partnershipRole String
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    responsibleGroupId Integer
    ID of the Group responsible for this Partner.
    responsibleUserId Integer
    ID of the User responsible for this Partner.
    rootFolder String
    The root folder path for this Partner.
    showPartnerChannelHomePage Boolean
    Show Partner users a simplified home page built from this Partner's Channels.
    tags String
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    userIds List<Integer>
    Array of User IDs that belong to this Partner.
    workspaceId Integer
    ID of the Workspace associated with this Partner.
    aiAssistantPersonalityId number
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    allowBypassing2faPolicies boolean
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    allowCredentialChanges boolean
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    allowProvidingGpgKeys boolean
    Allow Partner Admins to provide GPG keys.
    allowUserCreation boolean
    Allow Partner Admins to create users.
    allowedIps string
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    ccEmailsToResponsibleParty boolean
    When true, emails sent to Partner users are copied to the responsible User or Group.
    id number
    The unique ID of the Partner.
    name string
    The name of the Partner.
    notes string
    Notes about this Partner.
    partnerAdminIds number[]
    Array of User IDs that are Partner Admins for this Partner.
    partnerChannelTemplateId number
    ID of the Partner Channel Template assigned to this Partner.
    partnershipRole string
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    responsibleGroupId number
    ID of the Group responsible for this Partner.
    responsibleUserId number
    ID of the User responsible for this Partner.
    rootFolder string
    The root folder path for this Partner.
    showPartnerChannelHomePage boolean
    Show Partner users a simplified home page built from this Partner's Channels.
    tags string
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    userIds number[]
    Array of User IDs that belong to this Partner.
    workspaceId number
    ID of the Workspace associated with this Partner.
    ai_assistant_personality_id int
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    allow_bypassing2fa_policies bool
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    allow_credential_changes bool
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    allow_providing_gpg_keys bool
    Allow Partner Admins to provide GPG keys.
    allow_user_creation bool
    Allow Partner Admins to create users.
    allowed_ips str
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    cc_emails_to_responsible_party bool
    When true, emails sent to Partner users are copied to the responsible User or Group.
    id int
    The unique ID of the Partner.
    name str
    The name of the Partner.
    notes str
    Notes about this Partner.
    partner_admin_ids Sequence[int]
    Array of User IDs that are Partner Admins for this Partner.
    partner_channel_template_id int
    ID of the Partner Channel Template assigned to this Partner.
    partnership_role str
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    responsible_group_id int
    ID of the Group responsible for this Partner.
    responsible_user_id int
    ID of the User responsible for this Partner.
    root_folder str
    The root folder path for this Partner.
    show_partner_channel_home_page bool
    Show Partner users a simplified home page built from this Partner's Channels.
    tags str
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    user_ids Sequence[int]
    Array of User IDs that belong to this Partner.
    workspace_id int
    ID of the Workspace associated with this Partner.
    aiAssistantPersonalityId Number
    AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
    allowBypassing2faPolicies Boolean
    Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
    allowCredentialChanges Boolean
    Allow Partner Admins to change or reset credentials for users belonging to this Partner.
    allowProvidingGpgKeys Boolean
    Allow Partner Admins to provide GPG keys.
    allowUserCreation Boolean
    Allow Partner Admins to create users.
    allowedIps String
    A list of allowed IPs for this Partner. Newline delimited. Partner User IP access is allowed when the IP matches the Partner, User, or Site allowed IP lists.
    ccEmailsToResponsibleParty Boolean
    When true, emails sent to Partner users are copied to the responsible User or Group.
    id Number
    The unique ID of the Partner.
    name String
    The name of the Partner.
    notes String
    Notes about this Partner.
    partnerAdminIds List<Number>
    Array of User IDs that are Partner Admins for this Partner.
    partnerChannelTemplateId Number
    ID of the Partner Channel Template assigned to this Partner.
    partnershipRole String
    This site's role in Partner Site relationships for this Partner. Can be host, guest, hostAndGuest, or null.
    responsibleGroupId Number
    ID of the Group responsible for this Partner.
    responsibleUserId Number
    ID of the User responsible for this Partner.
    rootFolder String
    The root folder path for this Partner.
    showPartnerChannelHomePage Boolean
    Show Partner users a simplified home page built from this Partner's Channels.
    tags String
    Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags. Tags must only contain lowercase letters, numbers, and hyphens.
    userIds List<Number>
    Array of User IDs that belong to this Partner.
    workspaceId Number
    ID of the Workspace associated with this Partner.

    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