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

Endpoint

GET/integration_centric_profiles

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

curl https://app.files.com/api/rest/v1/integration_centric_profiles.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "id": 1,
    "name": "Business Systems Onboarding",
    "workspace_id": 1,
    "use_for_all_users": false,
    "expected_remote_servers": [
      "example"
    ]
  }
]

Show Integration Centric Profile

Endpoint

GET/integration_centric_profiles/{id}

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.

Request Parameters

ParameterDescription
id
int64
Required		Integration Centric Profile ID.

Example Request

curl https://app.files.com/api/rest/v1/integration_centric_profiles/{id}.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "Business Systems Onboarding",
  "workspace_id": 1,
  "use_for_all_users": false,
  "expected_remote_servers": [
    "example"
  ]
}

Create Integration Centric Profile

Endpoint

POST/integration_centric_profiles

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.

Request Parameters

ParameterDefaultDescription
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

curl https://app.files.com/api/rest/v1/integration_centric_profiles.json \
  -X POST \
  -H 'Content-Type: application/json' \
  -d '{"name":"Business Systems Onboarding","expected_remote_servers":["example"],"workspace_id":1,"use_for_all_users":false}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "Business Systems Onboarding",
  "workspace_id": 1,
  "use_for_all_users": false,
  "expected_remote_servers": [
    "example"
  ]
}

Update Integration Centric Profile

Endpoint

PATCH/integration_centric_profiles/{id}

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.

Request Parameters

ParameterDescription
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

curl https://app.files.com/api/rest/v1/integration_centric_profiles/{id}.json \
  -X PATCH \
  -H 'Content-Type: application/json' \
  -d '{"name":"Business Systems Onboarding","workspace_id":1,"expected_remote_servers":["example"],"use_for_all_users":false}' \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

{
  "id": 1,
  "name": "Business Systems Onboarding",
  "workspace_id": 1,
  "use_for_all_users": false,
  "expected_remote_servers": [
    "example"
  ]
}

Delete Integration Centric Profile

Endpoint

DELETE/integration_centric_profiles/{id}

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.

Request Parameters

ParameterDescription
id
int64
Required		Integration Centric Profile ID.

Example Request

curl https://app.files.com/api/rest/v1/integration_centric_profiles/{id}.json \
  -X DELETE \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

The IntegrationCentricProfile Object

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

Example IntegrationCentricProfile Object

{
  "id": 1,
  "name": "Business Systems Onboarding",
  "workspace_id": 1,
  "use_for_all_users": false,
  "expected_remote_servers": [
    "example"
  ]
}