Connector limitations
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
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details).
Supported objects and operations
Users
Table 162: Supported operations for Users
Get User |
GET |
Get All Users |
GET |
Groups
Not Applicable
Mandatory fields
Users
Not Applicable
Groups
Not Applicable
NOTE: Additional features supported: Workbooks connector supports attribute selection for the response based on the attributes mentioned in the query parameters ?attributes=.
User and Group mapping
The user and group mappings are listed in the tables below.
Table 163: User mapping
Id |
id |
userName |
login_name |
name.Formatted |
person_name |
displayName |
person_name |
emails[0].value |
login_name |
timezone |
timezone |
locale |
date_time_locale |
active |
is_enabled |
meta.created |
created_at |
meta.lastModified |
updated_at |
Groups
Not Applicable
-
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. Refer section Configuring integration application for detailed instructions.
-
Connector name
-
Admin User Id
-
Client Id
-
Private Key
-
Auth Server (account-d.docusign.com for developer environments and account.docusign.com for production environments)
- Account ID
-
Target URL (Cloud application's instance URL used as targetURI in payload)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)
Supported objects and operations
Users
Table 164: Supported operations for Users
Create User |
POST |
Update User |
PUT |
Delete User |
DELETE |
Get User |
GET |
Get All Users |
GET |
Get All Users with Pagination |
GET |
Groups
Table 165: Supported operations for Groups
Create Group |
POST |
Update Group |
PUT |
Delete Group |
DELETE |
Get Group |
GET |
Get All Groups |
GET |
Get All Groups with Pagination |
GET |
Update Membership |
PUT |
Mandatory fields
Users
Groups
User and Group mapping
The user and group mappings are listed in the tables below.
Table 166: User mapping
Id |
userId |
UserName |
userName |
UserType |
userType |
DisplayName |
userName |
Title |
jobTitle |
name.GivenName |
firstName |
name.FamilyName |
lastName |
Addresses.StreetAddress |
workAddress.address1 |
Addresses.Locality |
workAddress.address2 |
Addresses.Region |
workAddress.city |
Addresses.Country |
workAddress.country |
Addresses.postalCode |
workAddress.postalCode |
PhoneNumbers.Value |
workAddress.phone |
Emails.Value |
email |
Active |
userStatus |
Groups |
groupList |
Meta.Created |
createdDateTime |
Table 167: Group mapping
id |
groupId |
displayName |
groupName |
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.
Supervisor configuration parameters
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.
To configure the connector, following parameters are required. Refer section Configuring integration application for detailed instructions.
-
Connector name
-
Admin User Id
-
Client Id
-
Private Key
-
Auth Server (account-d.docusign.com for developer environments and account.docusign.com for production environments)
- Account ID
-
Target URL (Cloud application's instance URL used as targetURI in payload)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)
Supported objects and operations
Users
Table 164: Supported operations for Users
Create User |
POST |
Update User |
PUT |
Delete User |
DELETE |
Get User |
GET |
Get All Users |
GET |
Get All Users with Pagination |
GET |
Groups
Table 165: Supported operations for Groups
Create Group |
POST |
Update Group |
PUT |
Delete Group |
DELETE |
Get Group |
GET |
Get All Groups |
GET |
Get All Groups with Pagination |
GET |
Update Membership |
PUT |
Mandatory fields
Users
Groups
User and Group mapping
The user and group mappings are listed in the tables below.
Table 166: User mapping
Id |
userId |
UserName |
userName |
UserType |
userType |
DisplayName |
userName |
Title |
jobTitle |
name.GivenName |
firstName |
name.FamilyName |
lastName |
Addresses.StreetAddress |
workAddress.address1 |
Addresses.Locality |
workAddress.address2 |
Addresses.Region |
workAddress.city |
Addresses.Country |
workAddress.country |
Addresses.postalCode |
workAddress.postalCode |
PhoneNumbers.Value |
workAddress.phone |
Emails.Value |
email |
Active |
userStatus |
Groups |
groupList |
Meta.Created |
createdDateTime |
Table 167: Group mapping
id |
groupId |
displayName |
groupName |
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.
Supported objects and operations
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. Refer section Configuring integration application for detailed instructions.
-
Connector name
-
Admin User Id
-
Client Id
-
Private Key
-
Auth Server (account-d.docusign.com for developer environments and account.docusign.com for production environments)
- Account ID
-
Target URL (Cloud application's instance URL used as targetURI in payload)
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)
Users
Table 164: Supported operations for Users
Create User |
POST |
Update User |
PUT |
Delete User |
DELETE |
Get User |
GET |
Get All Users |
GET |
Get All Users with Pagination |
GET |
Groups
Table 165: Supported operations for Groups
Create Group |
POST |
Update Group |
PUT |
Delete Group |
DELETE |
Get Group |
GET |
Get All Groups |
GET |
Get All Groups with Pagination |
GET |
Update Membership |
PUT |
Mandatory fields
Users
Groups
User and Group mapping
The user and group mappings are listed in the tables below.
Table 166: User mapping
Id |
userId |
UserName |
userName |
UserType |
userType |
DisplayName |
userName |
Title |
jobTitle |
name.GivenName |
firstName |
name.FamilyName |
lastName |
Addresses.StreetAddress |
workAddress.address1 |
Addresses.Locality |
workAddress.address2 |
Addresses.Region |
workAddress.city |
Addresses.Country |
workAddress.country |
Addresses.postalCode |
workAddress.postalCode |
PhoneNumbers.Value |
workAddress.phone |
Emails.Value |
email |
Active |
userStatus |
Groups |
groupList |
Meta.Created |
createdDateTime |
Table 167: Group mapping
id |
groupId |
displayName |
groupName |
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.