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

IntegrationCentricProfile.list()

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.

Additional Arguments

Example Request

import IntegrationCentricProfile from 'files.com/lib/models/IntegrationCentricProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const integrationCentricProfiles = await IntegrationCentricProfile.list();
  for (const integrationCentricProfile of integrationCentricProfiles) {
    // Operate on integrationCentricProfile
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Integration Centric Profile

SDK Method

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

import IntegrationCentricProfile from 'files.com/lib/models/IntegrationCentricProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const integrationCentricProfile = await IntegrationCentricProfile.find(id);
  // Operate on integrationCentricProfile
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create Integration Centric Profile

SDK Method

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

import IntegrationCentricProfile from 'files.com/lib/models/IntegrationCentricProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const integrationCentricProfile = await IntegrationCentricProfile.create({
    name: "Business Systems Onboarding",
    expected_remote_servers: ["example"],
  });
  // Operate on integrationCentricProfile
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update Integration Centric Profile

SDK Method

integrationCentricProfile.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

import IntegrationCentricProfile from 'files.com/lib/models/IntegrationCentricProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the integrationCentricProfile object by its id.
  const integrationCentricProfile = await IntegrationCentricProfile.find(id);
  await integrationCentricProfile.update({
    name: "Business Systems Onboarding",
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete Integration Centric Profile

SDK Method

integrationCentricProfile.delete()

Return Object

No return value.

Authorization Requirement

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

Example Request

import IntegrationCentricProfile from 'files.com/lib/models/IntegrationCentricProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the integrationCentricProfile object by its id.
  const integrationCentricProfile = await IntegrationCentricProfile.find(id);
  await integrationCentricProfile.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

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.