Integration Centric Profiles

An Integration Centric Profile defines the Remote Server integrations a user is expected to add and connect during integration-centric onboarding.

Use this to automate setup guidance for users who need access to multiple business systems without sending long manual instructions. Common scenarios include ongoing access to systems such as SharePoint, bridging Google, Microsoft, and Box environments after M&A activity, and migrations where users connect legacy EFSS accounts during transition work.

List Integration Centric Profiles

SDK Method

Files::IntegrationCentricProfile.list

Return Object

List<IntegrationCentricProfile>

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
  integration_centric_profiles = Files::IntegrationCentricProfile.list
  integration_centric_profiles.auto_paging_each do |integration_centric_profile|
    # Operate on integration_centric_profile
  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 Integration Centric Profile

SDK Method

Files::IntegrationCentricProfile.find

Return Object

IntegrationCentricProfile

Authorization Requirement

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

Method Arguments

ArgumentDescription
id
int64
Required		Integration Centric Profile ID.

Example Request

begin
  integration_centric_profile = Files::IntegrationCentricProfile.find(id)
  # Operate on integration_centric_profile
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 Integration Centric Profile

SDK Method

Files::IntegrationCentricProfile.create

Return Object

IntegrationCentricProfile

Authorization Requirement

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

Method Arguments

ArgumentDefaultDescription
name
string
Required		Profile name
expected_remote_servers
array(object)
Required		Remote Server integrations the user is expected to add and connect. Each entry requires server_type and may include a display name.
workspace_id
int64		0Workspace ID
use_for_all_users
boolean		falseWhether this profile applies to all users in the Workspace by default

Example Request

begin
  integration_centric_profile = Files::IntegrationCentricProfile.create(
    name: "Business Systems Onboarding",
    expected_remote_servers: ["example"]
  )
  # Operate on integration_centric_profile
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 Integration Centric Profile

SDK Method

integration_centric_profile.update

Return Object

IntegrationCentricProfile

Authorization Requirement

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

Method Arguments

ArgumentDescription
name
string		Profile name
workspace_id
int64		Workspace ID
expected_remote_servers
array(object)		Remote Server integrations the user is expected to add and connect. Each entry requires server_type and may include a display name.
use_for_all_users
boolean		Whether this profile applies to all users in the Workspace by default

Example Request

begin
  # Find the integration_centric_profile object by its id.
  integration_centric_profile = Files::IntegrationCentricProfile.find(id)
  integration_centric_profile.update(
    name: "Business Systems Onboarding"
  )
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 Integration Centric Profile

SDK Method

integration_centric_profile.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 integration_centric_profile object by its id.
  integration_centric_profile = Files::IntegrationCentricProfile.find(id)
  integration_centric_profile.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 IntegrationCentricProfile Object

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

AttributeDescription
id
int64		Integration Centric Profile ID
name
string		Profile name
workspace_id
int64		Workspace ID
use_for_all_users
boolean		Whether this profile applies to all users in the Workspace by default
expected_remote_servers
array(object)		Remote Server integrations the user is expected to add and connect. Each entry requires server_type and may include a display name.