1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. PartnerSiteRequest
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 PartnerSiteRequest represents a request for a Guest Partner to add their Files.com Site to their Partnership with the Host Partner. The Guest Partner’s Files.com Site is referred to as the Guest Site in this relationship.

    The Partner Admin user representing the Guest on the Host Partner can initiate a request, which generates a pairing key. The Guest Site admin must then approve the request. This ensures that the Partner Admin user representing the Guest on the Host Partner and the Site Admins of the Site are in agreement that the linking should occur.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const examplePartnerSiteRequest = new filescom.PartnerSiteRequest("example_partner_site_request", {
        hostPartnerId: 1,
        guestSiteUrl: "guest_site_url",
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_partner_site_request = filescom.PartnerSiteRequest("example_partner_site_request",
        host_partner_id=1,
        guest_site_url="guest_site_url")
    
    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.NewPartnerSiteRequest(ctx, "example_partner_site_request", &filescom.PartnerSiteRequestArgs{
    			HostPartnerId: pulumi.Int(1),
    			GuestSiteUrl:  pulumi.String("guest_site_url"),
    		})
    		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 examplePartnerSiteRequest = new Filescom.PartnerSiteRequest("example_partner_site_request", new()
        {
            HostPartnerId = 1,
            GuestSiteUrl = "guest_site_url",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.PartnerSiteRequest;
    import com.pulumi.filescom.PartnerSiteRequestArgs;
    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) {
            var examplePartnerSiteRequest = new PartnerSiteRequest("examplePartnerSiteRequest", PartnerSiteRequestArgs.builder()
                .hostPartnerId(1)
                .guestSiteUrl("guest_site_url")
                .build());
    
        }
    }
    
    resources:
      examplePartnerSiteRequest:
        type: filescom:PartnerSiteRequest
        name: example_partner_site_request
        properties:
          hostPartnerId: 1
          guestSiteUrl: guest_site_url
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_partnersiterequest" "example_partner_site_request" {
      host_partner_id = 1
      guest_site_url  = "guest_site_url"
    }
    

    Create PartnerSiteRequest Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PartnerSiteRequest(name: string, args: PartnerSiteRequestArgs, opts?: CustomResourceOptions);
    @overload
    def PartnerSiteRequest(resource_name: str,
                           args: PartnerSiteRequestArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def PartnerSiteRequest(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           guest_site_url: Optional[str] = None,
                           host_partner_id: Optional[int] = None)
    func NewPartnerSiteRequest(ctx *Context, name string, args PartnerSiteRequestArgs, opts ...ResourceOption) (*PartnerSiteRequest, error)
    public PartnerSiteRequest(string name, PartnerSiteRequestArgs args, CustomResourceOptions? opts = null)
    public PartnerSiteRequest(String name, PartnerSiteRequestArgs args)
    public PartnerSiteRequest(String name, PartnerSiteRequestArgs args, CustomResourceOptions options)
    
    type: filescom:PartnerSiteRequest
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_partner_site_request" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PartnerSiteRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PartnerSiteRequestArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PartnerSiteRequestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PartnerSiteRequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PartnerSiteRequestArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var partnerSiteRequestResource = new Filescom.PartnerSiteRequest("partnerSiteRequestResource", new()
    {
        GuestSiteUrl = "string",
        HostPartnerId = 0,
    });
    
    example, err := filescom.NewPartnerSiteRequest(ctx, "partnerSiteRequestResource", &filescom.PartnerSiteRequestArgs{
    	GuestSiteUrl:  pulumi.String("string"),
    	HostPartnerId: pulumi.Int(0),
    })
    
    resource "filescom_partner_site_request" "partnerSiteRequestResource" {
      lifecycle {
        create_before_destroy = true
      }
      guest_site_url  = "string"
      host_partner_id = 0
    }
    
    var partnerSiteRequestResource = new PartnerSiteRequest("partnerSiteRequestResource", PartnerSiteRequestArgs.builder()
        .guestSiteUrl("string")
        .hostPartnerId(0)
        .build());
    
    partner_site_request_resource = filescom.PartnerSiteRequest("partnerSiteRequestResource",
        guest_site_url="string",
        host_partner_id=0)
    
    const partnerSiteRequestResource = new filescom.PartnerSiteRequest("partnerSiteRequestResource", {
        guestSiteUrl: "string",
        hostPartnerId: 0,
    });
    
    type: filescom:PartnerSiteRequest
    properties:
        guestSiteUrl: string
        hostPartnerId: 0
    

    PartnerSiteRequest Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PartnerSiteRequest resource accepts the following input properties:

    GuestSiteUrl string
    Guest Site URL
    HostPartnerId int
    Host Partner ID
    GuestSiteUrl string
    Guest Site URL
    HostPartnerId int
    Host Partner ID
    guest_site_url string
    Guest Site URL
    host_partner_id number
    Host Partner ID
    guestSiteUrl String
    Guest Site URL
    hostPartnerId Integer
    Host Partner ID
    guestSiteUrl string
    Guest Site URL
    hostPartnerId number
    Host Partner ID
    guest_site_url str
    Guest Site URL
    host_partner_id int
    Host Partner ID
    guestSiteUrl String
    Guest Site URL
    hostPartnerId Number
    Host Partner ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PartnerSiteRequest resource produces the following output properties:

    CreatedAt string
    Request creation date/time
    HostSiteName string
    Host Site Name
    Id string
    The provider-assigned unique ID for this managed resource.
    PairingKey string
    Pairing key used to approve this request on the Guest Site
    Status string
    Request status (pending, approved, rejected)
    UpdatedAt string
    Request last updated date/time
    CreatedAt string
    Request creation date/time
    HostSiteName string
    Host Site Name
    Id string
    The provider-assigned unique ID for this managed resource.
    PairingKey string
    Pairing key used to approve this request on the Guest Site
    Status string
    Request status (pending, approved, rejected)
    UpdatedAt string
    Request last updated date/time
    created_at string
    Request creation date/time
    host_site_name string
    Host Site Name
    id string
    The provider-assigned unique ID for this managed resource.
    pairing_key string
    Pairing key used to approve this request on the Guest Site
    status string
    Request status (pending, approved, rejected)
    updated_at string
    Request last updated date/time
    createdAt String
    Request creation date/time
    hostSiteName String
    Host Site Name
    id String
    The provider-assigned unique ID for this managed resource.
    pairingKey String
    Pairing key used to approve this request on the Guest Site
    status String
    Request status (pending, approved, rejected)
    updatedAt String
    Request last updated date/time
    createdAt string
    Request creation date/time
    hostSiteName string
    Host Site Name
    id string
    The provider-assigned unique ID for this managed resource.
    pairingKey string
    Pairing key used to approve this request on the Guest Site
    status string
    Request status (pending, approved, rejected)
    updatedAt string
    Request last updated date/time
    created_at str
    Request creation date/time
    host_site_name str
    Host Site Name
    id str
    The provider-assigned unique ID for this managed resource.
    pairing_key str
    Pairing key used to approve this request on the Guest Site
    status str
    Request status (pending, approved, rejected)
    updated_at str
    Request last updated date/time
    createdAt String
    Request creation date/time
    hostSiteName String
    Host Site Name
    id String
    The provider-assigned unique ID for this managed resource.
    pairingKey String
    Pairing key used to approve this request on the Guest Site
    status String
    Request status (pending, approved, rejected)
    updatedAt String
    Request last updated date/time

    Look up Existing PartnerSiteRequest Resource

    Get an existing PartnerSiteRequest resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PartnerSiteRequestState, opts?: CustomResourceOptions): PartnerSiteRequest
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_at: Optional[str] = None,
            guest_site_url: Optional[str] = None,
            host_partner_id: Optional[int] = None,
            host_site_name: Optional[str] = None,
            pairing_key: Optional[str] = None,
            status: Optional[str] = None,
            updated_at: Optional[str] = None) -> PartnerSiteRequest
    func GetPartnerSiteRequest(ctx *Context, name string, id IDInput, state *PartnerSiteRequestState, opts ...ResourceOption) (*PartnerSiteRequest, error)
    public static PartnerSiteRequest Get(string name, Input<string> id, PartnerSiteRequestState? state, CustomResourceOptions? opts = null)
    public static PartnerSiteRequest get(String name, Output<String> id, PartnerSiteRequestState state, CustomResourceOptions options)
    resources:  _:    type: filescom:PartnerSiteRequest    get:      id: ${id}
    import {
      to = filescom_partner_site_request.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    Request creation date/time
    GuestSiteUrl string
    Guest Site URL
    HostPartnerId int
    Host Partner ID
    HostSiteName string
    Host Site Name
    PairingKey string
    Pairing key used to approve this request on the Guest Site
    Status string
    Request status (pending, approved, rejected)
    UpdatedAt string
    Request last updated date/time
    CreatedAt string
    Request creation date/time
    GuestSiteUrl string
    Guest Site URL
    HostPartnerId int
    Host Partner ID
    HostSiteName string
    Host Site Name
    PairingKey string
    Pairing key used to approve this request on the Guest Site
    Status string
    Request status (pending, approved, rejected)
    UpdatedAt string
    Request last updated date/time
    created_at string
    Request creation date/time
    guest_site_url string
    Guest Site URL
    host_partner_id number
    Host Partner ID
    host_site_name string
    Host Site Name
    pairing_key string
    Pairing key used to approve this request on the Guest Site
    status string
    Request status (pending, approved, rejected)
    updated_at string
    Request last updated date/time
    createdAt String
    Request creation date/time
    guestSiteUrl String
    Guest Site URL
    hostPartnerId Integer
    Host Partner ID
    hostSiteName String
    Host Site Name
    pairingKey String
    Pairing key used to approve this request on the Guest Site
    status String
    Request status (pending, approved, rejected)
    updatedAt String
    Request last updated date/time
    createdAt string
    Request creation date/time
    guestSiteUrl string
    Guest Site URL
    hostPartnerId number
    Host Partner ID
    hostSiteName string
    Host Site Name
    pairingKey string
    Pairing key used to approve this request on the Guest Site
    status string
    Request status (pending, approved, rejected)
    updatedAt string
    Request last updated date/time
    created_at str
    Request creation date/time
    guest_site_url str
    Guest Site URL
    host_partner_id int
    Host Partner ID
    host_site_name str
    Host Site Name
    pairing_key str
    Pairing key used to approve this request on the Guest Site
    status str
    Request status (pending, approved, rejected)
    updated_at str
    Request last updated date/time
    createdAt String
    Request creation date/time
    guestSiteUrl String
    Guest Site URL
    hostPartnerId Number
    Host Partner ID
    hostSiteName String
    Host Site Name
    pairingKey String
    Pairing key used to approve this request on the Guest Site
    status String
    Request status (pending, approved, rejected)
    updatedAt String
    Request last updated date/time

    Import

    The pulumi import command can be used, for example:

    Partner Site Requests can be imported by specifying the id.

    $ pulumi import filescom:index/partnerSiteRequest:PartnerSiteRequest example_partner_site_request 1
    

    To learn more about importing existing cloud resources, see Importing resources.

    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