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 (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    integration_centric_profile "github.com/Files-com/files-sdk-go/v3/integrationcentricprofile"
)

integrationCentricProfileIterator, err := integration_centric_profile.List(files_sdk.IntegrationCentricProfileListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for integrationCentricProfileIterator.Next() {
    integrationCentricProfile := integrationCentricProfileIterator.integrationCentricProfile()
}
err = integrationCentricProfileIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

IntegrationCentricProfileFindParams Fields

FieldDescription
Id
int64
Required		Integration Centric Profile ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    integration_centric_profile "github.com/Files-com/files-sdk-go/v3/integrationcentricprofile"
)

integrationCentricProfile, err := integration_centric_profile.Find(files_sdk.IntegrationCentricProfileFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

IntegrationCentricProfileCreateParams Fields

FieldDefaultDescription
Name
string
Required		Profile name
ExpectedRemoteServers
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.
WorkspaceId
int64		0Workspace ID
UseForAllUsers
boolean		falseWhether this profile applies to all users in the Workspace by default

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    integration_centric_profile "github.com/Files-com/files-sdk-go/v3/integrationcentricprofile"
)

integrationCentricProfile, err := integration_centric_profile.Create(files_sdk.IntegrationCentricProfileCreateParams{
  Name: "Business Systems Onboarding",
  ExpectedRemoteServers: []map[string]interface{}{"example"}
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

IntegrationCentricProfileUpdateParams Fields

FieldDescription
Id
int64
Required		Integration Centric Profile ID.
Name
string		Profile name
WorkspaceId
int64		Workspace ID
ExpectedRemoteServers
array(object)		Remote Server integrations the user is expected to add and connect. Each entry requires server_type and may include a display name.
UseForAllUsers
boolean		Whether this profile applies to all users in the Workspace by default

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    integration_centric_profile "github.com/Files-com/files-sdk-go/v3/integrationcentricprofile"
)

integrationCentricProfile, err := integration_centric_profile.Update(files_sdk.IntegrationCentricProfileUpdateParams{
  Id: 1,
  Name: "Business Systems Onboarding"
})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

IntegrationCentricProfileDeleteParams Fields

FieldDescription
Id
int64
Required		Integration Centric Profile ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    integration_centric_profile "github.com/Files-com/files-sdk-go/v3/integrationcentricprofile"
)

err := integration_centric_profile.Delete(files_sdk.IntegrationCentricProfileDeleteParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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
WorkspaceId
int64		Workspace ID
UseForAllUsers
boolean		Whether this profile applies to all users in the Workspace by default
ExpectedRemoteServers
array(object)		Remote Server integrations the user is expected to add and connect. Each entry requires server_type and may include a display name.