Starling Connect Identity Manager Integrated - Administration Guide

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
Table 103: Supported operations for Users

Operation

VERB

Get User

GET

Get All Users

GET

Groups

Not Applicable

Mandatory Fields

Users

Not Applicable

Groups

Not Applicable

User and Group Mapping

The user and group mappings are listed in the tables below.

Table 104: User Mapping
SCIM Parameter Workbooks Parameter
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

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 105: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete User

DELETE

Get User

GET

Get All Users

GET

Get All Users with Pagination

GET

Groups
Table 106: Supported operations for Groups

Operation

VERB

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
  • UserName
  • Email
Groups
  • DisplayName

User and Group Mapping

The user and group mappings are listed in the tables below.

Table 107: User Mapping
SCIM Parameter Oracle IDCS Parameter
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 108: Group Mapping
SCIM Parameter Oracle IDCS Parameter

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.

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 109: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PATCH

Delete User

DELETE

Get User

GET

Get All Users

GET

Groups
Table 110: Supported operations for Groups

Operation

VERB

Create Group

POST

Update Group

PATCH

Delete Group

DELETE

Get Group

GET

Get Group Members

GET

Add Group Members

POST

Remove Group Members

DELETE

Get All Groups

GET

Mandatory Fields

Users
  • emails.value
  • name.familyName

  • name.givenName

Groups

Not Applicable

User and Group Mapping

The user and group mappings are listed in the tables below.

Table 111: User Mapping
SCIM Parameter ShareFile Parameter
Id id
userName email
name.Formatted FullName
Name.FamilyName LastName
Name.GivenName FirstName
Password Password
DisplayName FullName
email.value email
Active IsDeleted
Extension.Organization Company
Created DateCreated
Groups
Table 112: User Mapping
SCIM Parameter ShareFile Parameter
Id id
DisplayName Name
members.value User.Id
members.display User.FirstName+User.LastName

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.

Zendesk

Zendesk is a unified customer service platform. It features a common user interface, single login, and a platform for sharing customer data.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • User Name

  • Password

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

Supported Objects and Operations

Users
Table 113: Supported operations for Users

Operation

VERB

Create User

POST

Update User

PUT

Delete User

DELETE

Get User

GET

Get All Users

GET

Get All Users with Pagination

GET

Groups
Table 114: Supported operations for Users

Operation

VERB

Create Group

POST

Update Group

PUT

Delete Group

DELETE

Get Groups

GET

Get All Groups

GET

Get All Users with Pagination

GET

Update Membership

PUT

Mandatory Fields

Users
  • DisplayName
  • Email
Groups

DisplayName

User and Group Mapping

The user and group mappings are listed in the tables below.

Table 115: User Mapping
SCIM Parameter Zendesk Parameter
Id id
UserName email

DisplayName

name

Timezone

time_zone

Locale

locale

PhoneNumbers[].Value phone
Emails[].Value email

Active

active

Meta.Created

created_at

Meta.LastModified

updated_at

Groups
Table 116: Groups Mapping
SCIM Parameter Zendesk Parameter
Id id

DisplayName

name

Meta.Created

created_at

Meta.LastModified

updated_at

Connector Limitations

  • A user with Agent role only can be added to group membership.

  • Get resource by pagination will always return the resources in multiples of hundred. For example, if the count is specified as 126, 200 records are returned.

  • If any value for startIndex is passed when using get resources by pagination parameter, the result from the connector is always the nearest 100 records from the requested number.

  • Users can be deleted multiple times as the cloud application supports soft delete.

Documentos relacionados