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

Command

files-cli integration-centric-profiles list

Output

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

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

files-cli integration-centric-profiles list

Show Integration Centric Profile

Command

files-cli integration-centric-profiles find

Output

Outputs a IntegrationCentricProfile object according to the output format.

Authorization Requirement

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

Flags

FlagDescription
--id=
int64
Required		Integration Centric Profile ID.

Example Request

files-cli integration-centric-profiles find \
  --id=1

Create Integration Centric Profile

Command

files-cli integration-centric-profiles create

Output

Outputs a IntegrationCentricProfile object according to the output format.

Authorization Requirement

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

Flags

FlagDefaultDescription
--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

files-cli integration-centric-profiles create \
  --name="Business Systems Onboarding"

Update Integration Centric Profile

Command

files-cli integration-centric-profiles update

Output

Outputs a IntegrationCentricProfile object according to the output format.

Authorization Requirement

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

Flags

FlagDescription
--id=
int64
Required		Integration Centric Profile ID.
--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

files-cli integration-centric-profiles update \
  --id=1 \
  --name="Business Systems Onboarding"

Delete Integration Centric Profile

Command

files-cli integration-centric-profiles delete

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
--id=
int64
Required		Integration Centric Profile ID.

Example Request

files-cli integration-centric-profiles delete \
  --id=1

The IntegrationCentricProfile Object

Some of the commands 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.