Partners

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

List Partners

SDK Method

Files::Partner.list

Return Object

List<Partner>

Authorization Requirement

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

Additional Arguments

Example Request

begin
  partners = Files::Partner.list
  partners.auto_paging_each do |partner|
    # Operate on partner
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Partner

SDK Method

Files::Partner.find

Return Object

Partner

Authorization Requirement

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

Method Arguments

Argument	Description
id int64 Required	Partner ID.

Example Request

begin
  partner = Files::Partner.find(id)
  # Operate on partner
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Partner

SDK Method

Files::Partner.create

Return Object

Partner

Authorization Requirement

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

Method Arguments

Argument	Default	Description
ai_assistant_personality_id int64		AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
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.
allow_bypassing_2fa_policies boolean	`false`	Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
allow_credential_changes boolean	`false`	Allow Partner Admins to change or reset credentials for users belonging to this Partner.
allow_providing_gpg_keys boolean	`false`	Allow Partner Admins to provide GPG keys.
allow_user_creation boolean	`false`	Allow Partner Admins to create users.
cc_emails_to_responsible_party boolean	`false`	When `true`, emails sent to Partner users are copied to the responsible User or Group.
notes string		Notes about this Partner.
partner_channel_template_id int64		ID of the Partner Channel Template assigned to this Partner.
responsible_group_id int64		ID of the Group responsible for this Partner.
responsible_user_id int64		ID of the User responsible for this Partner.
show_partner_channel_home_page boolean	`false`	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.
name string Required		The name of the Partner.
root_folder string Required		The root folder path for this Partner.
workspace_id int64	`0`	ID of the Workspace associated with this Partner.

Example Request

begin
  partner = Files::Partner.create(
    name: "Acme Corp",
    root_folder: "/AcmeCorp"
  )
  # Operate on partner
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Partner

SDK Method

partner.update

Return Object

Partner

Authorization Requirement

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

Method Arguments

Argument	Description
ai_assistant_personality_id int64	AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
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.
allow_bypassing_2fa_policies boolean	Allow Partner Admins to change Two-Factor Authentication requirements for Partner Users.
allow_credential_changes boolean	Allow Partner Admins to change or reset credentials for users belonging to this Partner.
allow_providing_gpg_keys boolean	Allow Partner Admins to provide GPG keys.
allow_user_creation boolean	Allow Partner Admins to create users.
cc_emails_to_responsible_party boolean	When `true`, emails sent to Partner users are copied to the responsible User or Group.
notes string	Notes about this Partner.
partner_channel_template_id int64	ID of the Partner Channel Template assigned to this Partner.
responsible_group_id int64	ID of the Group responsible for this Partner.
responsible_user_id int64	ID of the User responsible for this Partner.
show_partner_channel_home_page 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.
name string	The name of the Partner.
root_folder string	The root folder path for this Partner.

Example Request

begin
  # Find the partner object by its id.
  partner = Files::Partner.find(id)
  partner.update(
    ai_assistant_personality_id: 1
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Partner

SDK Method

partner.delete

Return Object

nil

Authorization Requirement

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

Example Request

begin
  # Find the partner object by its id.
  partner = Files::Partner.find(id)
  partner.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The Partner Object

Some of the methods above return a Partner object. The attributes of this object are listed below.

Attribute	Description
allow_bypassing_2fa_policies boolean	Allow Partner Admins to change Two-Factor Authentication requirements for Partner 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.
allow_credential_changes boolean	Allow Partner Admins to change or reset credentials for users belonging to this Partner.
allow_providing_gpg_keys boolean	Allow Partner Admins to provide GPG keys.
allow_user_creation boolean	Allow Partner Admins to create users.
cc_emails_to_responsible_party boolean	When `true`, emails sent to Partner users are copied to the responsible User or Group.
id int64	The unique ID of the Partner.
ai_assistant_personality_id int64	AI Assistant Personality ID assigned to this Partner, if any. Users in the Partner inherit it unless a direct per-user assignment overrides it.
workspace_id int64	ID of the Workspace associated with this Partner.
name string	The name of the Partner.
notes string	Notes about this Partner.
partner_admin_ids array(int64)	Array of User IDs that are Partner Admins for this Partner.
partner_channel_template_id int64	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`, `host_and_guest`, or null. Possible values: `host`, `guest`, `host_and_guest`
responsible_group_id int64	ID of the Group responsible for this Partner.
responsible_user_id int64	ID of the User responsible for this Partner.
root_folder string	The root folder path for this Partner.
show_partner_channel_home_page 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.
user_ids array(int64)	Array of User IDs that belong to this Partner.

Partners

List Partners

SDK Method

Return Object

Authorization Requirement

Additional Arguments

Pagination

Sorting

Filtering

Show Partner

SDK Method

Return Object

Authorization Requirement

Method Arguments

Create Partner

SDK Method

Return Object

Authorization Requirement

Method Arguments

Update Partner

SDK Method

Return Object

Authorization Requirement

Method Arguments

Delete Partner

SDK Method

Return Object

Authorization Requirement

The Partner Object