Partner Site Requests

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.

List Partner Site Requests

Command

files-cli partner-site-requests list

Output

Outputs a list of PartnerSiteRequest objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Additional Arguments

Example Request

files-cli partner-site-requests list

Find partner site request by pairing key

Command

files-cli partner-site-requests find-by-pairing-key

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--pairing-key=
string
Required		Pairing key for the partner site request

Example Request

files-cli partner-site-requests find-by-pairing-key \
  --pairing-key="pairing_key"

Create Partner Site Request

Command

files-cli partner-site-requests create

Output

Outputs a PartnerSiteRequest object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--host-partner-id=
int64
Required		Host Partner ID to link with
--guest-site-url=
string
Required		Guest Site URL to link to

Example Request

files-cli partner-site-requests create \
  --host-partner-id=1 \
  --guest-site-url="guest_site_url"

Reject partner site request

Command

files-cli partner-site-requests reject

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--pairing-key=
string
Required		Pairing key for the partner site request

Example Request

files-cli partner-site-requests reject \
  --pairing-key="pairing_key"

Approve partner site request

Command

files-cli partner-site-requests approve

Output

No output is returned.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--pairing-key=
string
Required		Pairing key for the partner site request

Example Request

files-cli partner-site-requests approve \
  --pairing-key="pairing_key"

Delete Partner Site Request

Command

files-cli partner-site-requests delete

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Partner Site Request ID.

Example Request

files-cli partner-site-requests delete \
  --id=1

The PartnerSiteRequest Object

Some of the commands above return a PartnerSiteRequest object. The attributes of this object are listed below.

AttributeDescription
id
int64		Partner Site Request ID
host_partner_id
int64		Host Partner ID
guest_site_url
string		Guest Site URL
status
string		Request status (pending, approved, rejected)
Possible values: pending, approved, rejected
host_site_name
string		Host Site Name
pairing_key
string		Pairing key used to approve this request on the Guest Site
created_at
date-time		Request creation date/time
updated_at
date-time		Request last updated date/time