Chat now with support
Chat with Support

Starling Connect Hosted - Active Roles Administration Guide

Zendesk Sell

Zendesk Sell provides a web-based sales platform with tools for emailing, phone dialing, pipeline management, forecasting, and reporting.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • API Key

  • Target URL (Cloud application's instance URL used as targetURI in payload)

Supported Objects and Operations

Users

Not Applicable

Groups

Not Applicable

Mandatory Fields

Users

Not Applicable

Groups

Not Applicable

Connector Limitations

  • Create, Update, and Delete users are not supported by Zendesk Sell connector.

  • The resultant (User) objects count of pagination is always in the multiples of 100, unless cloud has less than 100 records in a page.

Workbooks

Workbooks is a cloud-based CRM and business application for users in sales, marketing, and customer support. It also offers services for order management and fulfillment, invoicing, and supplier management.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • API key for the cloud account (obtained from Start > Configuration > Email & Integration > API Keys in Workbooks Desktop instance)

  • Target URL of the cloud account

Supported Objects and Operations

Users

Not Applicable

Groups

Not Applicable

Mandatory Fields

Users

Not Applicable

Groups

Not Applicable

Connector Limitations

  • Create, Update, and Delete users are not supported.

  • Groups and group memberships are not supported through APIs.

  • Username is available only for the activated users.

  • Get All Users retrieves automation users that are not listed in the users list in Workbooks user interface. The automation users are created while generating the first API key of type automation in Workbooks Desktop instance.

  • The application returns the user details instead of 404 error though the user id is appended with alphabetic characters.

DocuSign

DocuSign allows users to manage digital transactions for electronic documents including contracts and signatures. Its features include authentication services, user identity management, and workflow automation.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • Client Id

  • User Name

  • Password

  • Account ID
  • Target URL (Cloud application's instance URL used as targetURI in payload)

Supported Objects and Operations

Users
Table 62: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete User

DELETE

Groups
Table 63: Supported operations for Groups

Operation

VERB

Create Group POST
Update Group PUT

Delete Group

DELETE

Deprovision

PUT

Undo Deprovision

PUT

Update Membership

PUT

Mandatory Fields

Users
  • UserName
  • Email
Groups
  • DisplayName

Connector Limitations

  • Username update is accepted only when no first and last name provided.

  • Add and update of Users address not supported.

  • Intermittently, you cannot update the users when the activation is in pending status.

  • Active user cannot be created. After the created user activates the account through the email link, the user is considered to be an Active user.

  • Combination of user name and email duplication will result in conflict error response.

ShareFile

ShareFile offers users a platform for secure content collaboration, file sharing, and synchronization for documents and workflows. It offers cloud-based and on-premises storage, virtual data rooms, and client portals.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • UserName

  • Password

  • Client_Id

  • Client_Secret

  • Target URL (Cloud application's instance URL used as targetURI in payload)

Supported Objects and Operations

Users
Table 64: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PATCH

Delete User

DELETE

Get User

GET

Get All Users

GET

Groups
Table 65: Supported operations for Groups

Operation

VERB

Create Group

POST

Update Group

PATCH

Delete Group

DELETE

Add Group Members

POST

Remove Group Members

DELETE

Deprovision

PUT

Undo Deprovision

PUT

Mandatory Fields

Users
  • emails.value
  • name.familyName

  • name.givenName

Groups

Not Applicable

Connector Limitations

  • Pagination is not supported by cloud application for both Users and Groups object

  • Group Information such as, the groups to which the user is associated is not displayed when we retrieve Users object.

  • Only 5 users can be created for trial instance on the Cloud Application.

  • Email id is considered as your user name. To update the username, you should update the email id.

  • Last modified date is not supported by the Cloud application for User object.

  • Last Modified and Created date is not supported by the Cloud application for Group object.

  • Deleted users can be retrieved as the Cloud application supports soft delete of users.

  • Deleted user can be updated though the User Id.
  • Group membership operation can be ignored when you have an invalid User Id in the members list.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating