Starling Connect Identity Manager Integrated - Administration Guide

Nutshell

Nutshell is a customer relationship management (CRM) service. It can be integrated with other SaaS services for small businesses, including Google Apps.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • Username for the cloud account

  • Password - API Key

  • Target URL of the cloud account

Supported Objects and Operations

Users
Table 75: Supported operations for Users

Operation

VERB

Create

POST

Update

PUT

Delete

DELETE

Get user by Id

GET

Get all users

GET

Get all users with pagination

GET

Groups
Table 76: Supported operations for Groups

Operation

VERB

Create POST
Update

PUT

Delete DELETE
Get group by Id GET
Get all groups GET

Get all groups with pagination

GET

Mandatory Fields

Users
  • emails.value

Groups
  • displayName

User and Group Mapping

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

Table 77: User Mapping
SCIM Parameter Nutshell Parameter
id id
userName email

name.familyName

lastName
name.givenName firstName
displayName name
emails[0].value email
active isEnabled
groups teams
meta.created createdTime
meta.lastModified modifiedTime

 

Table 78: Group Mapping
SCIM Parameter Nutshell Parameter
id id
displayName name
enterpriseExtension.division division
meta.created createdTime

meta.lastModified

modifiedTime

Connector Limitations

  • Error messages and status codes are not customized. The following status codes are returned:

    • 200
    • 201
    • 204
    • 400
    • 401
    • 404
  • Members cannot be added or retrieved from teams (groups) via the team endpoints. This can be achieved using the user endpoints and, updating the individual users. However, considering the large number of users in live production environments, membership management is not supported by the connector, as performance issues may arise.
  • The delete operation is soft delete. Hence, it is possible to delete, or retrieve the deleted user or group multiple number of times. However, a deleted group will not be retrieved as part of the list groups response.
  • Multiple email addresses can be associated to a user. Hence, the first email Id from the Nutshell user response is considered as the email id for the SCIM user.
  • The NutShell API does not provide information on retrieval of all resources through paginated requests. Hence, the connector provides a nextCursor value, when the total resource count is divisible by requested count.

Insightly

Insightly provides customer relationship management software for small and midsize businesses. It can be integrated with other applications such as Box, Dropbox, Gmail, Outlook, and QuickBooks. Its dashboard lets users create custom reports and track projects.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • API Key

  • SCIM URL (Cloud application's instance URL, used as the target URL in payload)

Supported Objects and Operations

Users
Table 79: Supported operations for Users

Operation

VERB

Get user by Id

GET

Get all users

GET

Groups
Table 80: Supported operations for Groups

Operation

VERB

Create POST
Update

PUT

Delete DELETE
Get group by Id GET
Get all groups GET

Mandatory Fields

Users
  • Creation of users is not supported.

Groups
  • DisplayName

User and Group Mapping

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

Table 81: User Mapping
SCIM Parameter Insightly Parameter
Id USER_ID
emails[0].value EMAIL_ADDRESS

DisplayName

FIRST_NAME + LAST_NAME
name.FirstName FIRST_NAME
name.LastName LAST_NAME
name.Formatted FIRST_NAME + LAST_NAME
active ACTIVE

timezone

TIMEZONE_ID

meta.created DATE_CREATED_UTC
userName EMAIL_ADDRESS
meta.lastModified DATE_UPDATED_UTC

 

Table 82: Group Mapping
SCIM Parameter Insightly Parameter
id TEAM_ID
displayName TEAM_NAME
created DATE_CREATED_UTC
lastModified DATE_UPDATED_UTC

members[].value

TEAMMEMBERS[].MEMBER_USER_ID

Connector Limitations

  • Create, Update, and Delete operation (for Users) are not supported.
  • During the process of creating or updating a group, if the member data is incorrect, the operation fails with Bad request status code.

  • It is possible to create multiple groups with the same name in Insightly cloud application.

 

NOTE: If the version of One Identity Manager is 8.0.2 , an error is returned, if the Group objects are more than four. If the version of One Identity Manager is 7.1.4, the display names of few groups would be missing in the Manager console of One Identity Manager, if the Group objects are more than twenty. The cause for the above mentioned irregularities is that, the Insightly cloud application can handle only five requests per second, if the account is a trial version.

Egnyte

Egnyte lets users store files on either a company’s existing data center infrastructure or in the cloud. It can be integrated with the cloud, storage, devices, and business applications to let you control data with your current hardware.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • Client_Id (API Key provided for the application)

  • Username

  • Password

  • Target URL (cloud application's instance URL used as target URL in payload)

To get the Client_id

  1. Login to the Egnyte cloud application.
  2. Register an application under My API Keys menu. Registered Application will have an API key that can be used as Client_Id.

Supported Objects and Operations

Users
Table 83: Supported operations for Users

Operation

VERB

Create

POST

Update

PUT

Delete

DELETE

Get user by Id

GET

Get all users

GET

Get all users with pagination

GET

Groups
Table 84: Supported operations for Groups

Operation

VERB

Create POST
Update

PUT

Delete DELETE
Get all groups GET

Get all groups with pagination

GET

Mandatory Fields

Users
  • userName

  • emails.value
  • name.givenName

  • name.familyName

  • EnterpriseExtension.authType

  • userType

  • active
Groups
  • displayName

User and Group Mapping

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

Table 85: User Mapping
SCIM Parameter Egnyte Parameter
Id Id
externalId externalId

userName

userName

Name.FamilyName

name.FamilyName
Name.givenName name.givenName
Name.Formatted name.Formatted
DisplayName name.Formatted
email.value email
Active active
userType userType
EnterpriseExtension.authType authType

Groups.DisplayName

groups.DisplayName

Groups.Value

groups.Value

Created

createdDate

LastModified

lastModificationDate

 

Table 86: Group Mapping
SCIM Parameter Egnyte Parameter
Id id
displayName displayName
members.value members.value
members.display members.display

Connector Limitations

  • The Role object type is not supported by cloud application for trial account. Hence, the connector does not support the role endpoint.

SugarCRM

SugarCRM is a customer relationship management (CRM) system. It allows users to manage sales-force automation, marketing campaigns, customer support, collaboration, mobile CRM, social CRM, and reporting.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • Client Id

  • Client Secret
  • Username

  • Password

  • Platform
  • Target URL (cloud application's instance URL used as target URL in payload)

Supported Objects and Operations

Users
Table 87: Supported operations for Users

Operation

VERB

Create

POST

Update

PUT

Delete

DELETE

Get user by Id

GET

Get all users

GET

Groups
Table 88: Supported operations for Groups

Operation

VERB

Create POST
Update

PUT

Delete DELETE
Get all groups GET

Get all groups by Id

GET

Mandatory Fields

Users
  • UserName

Groups
  • Not Applicable

User and Group Mapping

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

Table 89: User Mapping
SCIM Parameter SugarCRM Parameter
Id id
UserName user_name

Title

title

PreferredLanguage

preferred_language

name.FirstName

first_name
name.LastName last_name
name.Formatted full_name
Address.StreetAddress address_street
Address.Region address_city
Address.Country address_country
Address.PostalCode address_postalcode
Emails.value email[0].email_address

Active

status.Value == "Active"

Groups[].display

team_name[].name

Groups[].value

team_name[].id

PhoneNumbers[].Value

phone_home

PhoneNumbers[].Value

phone_mobile

PhoneNumbers[].Value

phone_work

Meta.Created

date_entered

Meta.LastModified

date_modified

 

Table 90: Group Mapping
SCIM Parameter SugarCRM Parameter
id id
displayName name
Meta.created date_entered
Meta.lastModified date_modified

Connector Limitations

  • Creation of a duplicate user returns the following status code:

    • 403:Forbidden
  • A CRUD operation on Users and Groups can be performed only by users with Admin credentials.
  • Multiple groups can be created with same name.
  • Group memberships cannot be added, retrieved, or modified using API calls.

  • Cloud application allows creation of a group without the Name being specified.

Documentos relacionados