Connector Group represent classes of Connectors - external API servers that connector ShareFile clients with other data sources, such as Network Shares, SharePoint sites, other Cloud Services, or any other 3rd-party data sources.

Get all Connector Groups in the account

GET https://account.sf-api.com/sf/v3/ConnectorGroups

Retrieves a Connector Group

Returns: A single ConnectorGroup object matching the query

Get the Connector Group by Service ID

GET https://account.sf-api.com/sf/v3/ConnectorGroups(id)

Retrieves a Connector Group

String

Service Identifier

Returns: A single ConnectorGroup object matching the query

Get the Connector Group by Provider

GET https://account.sf-api.com/sf/v3/ConnectorGroups/ByProvider?provider=theProvider

provider

String

Returns: A single ConnectorGroup matching the query

Get the Connector Group by Service ID

GET https://account.sf-api.com/sf/v3/ConnectorGroups(serviceid)/Zones(zoneid)

Retrieves a Connector Group

parentid	String	Connector Group identifier
id	String	Zone identifier

Returns: A single ConnectorGroup object matching the query

Get an Access Control element

GET https://account.sf-api.com/sf/v3/ConnectorGroups(serviceid)/AccessControls(userid)

Retrieves a Connector Group Access Control of a given user

parentid	String	Service Identifier
id	String	User Identifier

Returns: A single ConnectorGroup ACL object matching the query

Get Connector Groups in a Zone

GET https://account.sf-api.com/sf/v3/ConnectorGroups/GetByZone(zoneid)

Retrieves the Connector Groups defined in a Zone.

zoneid

String

Zone identifier

Returns: Access Control List of the given object ID.

Create a Connector Group associated with a Zone

POST https://account.sf-api.com/sf/v3/ConnectorGroups 
            { 
             "Zones":[ { 
               "Zone": {"Id":"ZoneId"}, 
               "StorageCenter": [ { "Id":"StorageCenterId001" }, { "Id":"StorageCenterId002" } ], 
               "ApiVersionMin":"v3", 
               "ApiVersionMax":"v3", 
               "IconUrl":"https://domain/icons", 
               "FormUrl":"https://domain/forms" 
             } ], 
             "Id":"ServiceId", 
             "Name":"Name", 
             "Provider":"svc" 
            }

Creates a new Connector Group, or adds a Zone to an existing Connector Group if the Group is already associated with another Zone. The caller doesn't have to check if the group exists or not - just call this API passing the Service ID and the associated Zone information.

connectorGroup

ConnectorGroup

Connector Group to create

Returns: the created or modified AccessControl instance

Associates a Zone with an existing Connector Group

POST https://account.sf-api.com/sf/v3/ConnectorGroups(id)/Zone 
            { 
               "Zone": {"Id":"ZoneId"}, 
               "StorageCenter": [ { "Id":"StorageCenterId001" }, { "Id":"StorageCenterId002" } ], 
               "ApiVersionMin":"v3", 
               "ApiVersionMax":"v3", 
               "IconUrl":"https://domain/icons", 
               "FormUrl":"https://domain/forms" 
            }

Adds a Zone to an existing Connector Group.

id	String	Connector Group identifier
connectorGroupZone	ConnectorGroupZone	Connector Group Zone specification

Returns: the created or modified ConnectorGroupZone instance

Adds a new principal to the Connector Group Access Control List

POST https://account.sf-api.com/sf/v3/ConnectorGroups(id)/AccessControls 
            { 
               "Principal": {"Id":"PrincipalId"}, 
               "CanCreate":"true", 
               "CanManage":"true" 
            }

id	String	Connector Group identifier
connectorGroupAcl	ConnectorGroupAccessControl	Connector Group Access Control List specification

Returns: The created access control list object

Modifies the parameters of a Connector Group in associated with a Zone

PATCH https://account.sf-api.com/sf/v3/ConnectorGroups(id)/Zones(zoneid) 
            { 
             "Zone": {"Id":"ZoneId"}, 
             "ApiVersionMin":"v3", 
             "ApiVersionMax":"v3", 
             "IconUrl":"https://domain/icons", 
             "FormUrl":"https://domain/forms" 
            }

id	String	Item identifier
zoneId	String	Zone Identifier
connectorGroupZone	ConnectorGroupZone	New specification of the Connector Group Zone element

Returns: the created or modified ConnectorGroupZone instance

Removes a Connector Group

DELETE https://account.sf-api.com/sf/v3/ConnectorGroups(id)

Removes a Connector Group and all associations from Zones

String

Connector Group Service Identifier

Removes a Connector Group association with a Zone

DELETE https://account.sf-api.com/sf/v3/ConnectorGroups(parentid)/Zones(id)

Removes a Connector Group association with a Zone. Connector Groups are automatically removed once the groups is removed from all the Zones.

serviceid	String	Connector Group Service Identifier
zoneid	String	Zone Identifier

Removes a Connector Group Access Control object

DELETE https://account.sf-api.com/sf/v3/ConnectorGroups(parentid)/AccessControls(userid)

Removes an Access Control object from the Connector Group ACL. This removes the permissions of the affected principal to use the Connector Group.

serviceid	String	Connector Group Service Identifier
id	String	User Identifier

Retrieve the list of Storage Centers associated with a Connector Group

GET https://account.sf-api.com/sf/v3/ConnectorGroups(id)/Zones(zoneid)/StorageCenters

Retrieve the list of storage centers associated with a Connector Group.

id	String	Connector Group identifier
zoneid	String	Zone identifier

Returns: The modified Connector Group

Adds a Connector Group to a Storage Center

POST https://account.sf-api.com/sf/v3/ConnectorGroups(id)/Zones(zoneid)/StorageCenters 
            { 
              "Id":"storageCenterId" 
            }

Associate a Connector Group with a Storage Center. The Connector Group has to be associated with the Storage Center Zone.

id	String	Connector Group identifier
zoneid	String	Zone identifier
storageCenter	StorageCenter	Storage Center

Returns: The modified Connector Group