Chat now with support
Chat with Support

Starling Connect Hosted - Active Roles Administration Guide

Box

Box lets users securely store, access, share, and collaboratively work on files across devices. It is accessible through web and mobile applications and REST APIs. It features functions such as search, metadata, granular permission models, enterprise-grade security, retention policies, and preview capabilities.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • Client Id

  • Client Secret

  • Public Key

  • Private Key
  • Pass Phrase
  • Enterprise Id

To get the Box credentials

  1. Create an account in Box.

  2. Log in to the Box account . The URL will be similar to https://{Business_Name}.app.box.com/folder/0.

  3. Navigate to the Developer console.

  4. Create a new custom application.

  5. Select OAuth 2.0 with JWT (server authentication) as the authentication method.

  6. Enter a relevant name for the application that is to be created.

  7. Click View App and navigate to the Configuration section.

  8. Set the value of Application Access to Enterprise.

  9. Enable the advanced features by selecting the following options:

    • Perform action as Users
    • Generate User access token

  10. In the Add and manage public keys section, click generate Public/Private Key pair button. A config JSON file gets downloaded and it includes the credentials, that are required to get the access token for authentication.

Supported Objects and Operations

Users
Table 26: Supported operations for Users

Operation

VERB

Create

POST

Update

PUT

Delete

DELETE

Deprovision  
Undo Deprovision  
Groups
Table 27: Supported operations for Groups

Operation

VERB
Create POST

Mandatory Fields

Users
  • DisplayName
  • Email ID
Groups

  • DisplayName

User and Group Mapping

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

Table 28: User Mapping
SCIM Parameter Box Parameter
id id
email[0].value login

userName

 login
name.formatted name
displayName name
active status
address[0].formatted address
userType type
PhoneNumbers[0].Value phone
active status
title job_title

preferredLanguage

 language

timezone

 timezone

meta.created

created_at

meta.astModified

modified_at

 

Table 29: Group Mapping
SCIM Parameter Box Parameter
id id
name displayName
created created_at
lastModified modified_at

members[].value

user[].id

members[].display

user[].name

Trello

Trello is a web-based project organizer with both free and paid services. Users can create projects, with room to add comments, additional information, and attachments.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector Name

  • API Key for the cloud account
  • Access token for the cloud account

Supported Objects and Operations

Groups
Table 30: Supported operations and objects for Groups

Operation

VERB
Create POST
Update PUT
Delete DELETE
Deprovision PUT
Undo Deprovision PUT

Mandatory Fields

Groups

  • displayName

User and Group Mapping

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

Table 31: User Mapping
SCIM Parameter Trello Parameter
id id
userName username
name.formatted fullName
displayName fullName
emails[0].value email
active confirmed
groups[].value
organizations[].id
boards[].id
groups[].display
organizations[].displayName
boards[].name

 

Table 32: Group Mapping
SCIM Parameter Trello Parameter
id id
displayName
organization.displayName
board.name
extension.description
organization.desc
board.desc
extension.name organization.name
extension.organizationId board.idOrganization

members[].value

members[].id

members[].display

members[].fullName

Connector Limitations

  • The Created and LastModified dates are not supported for Users and Groups.

  • Pagination is not supported for getting Users and Groups.

  • Invalid Target URL throws the following status code and message:

    • Code: 500
    • Message: There was an issue processing this request error

  • Create, Update and Delete operations are not supported for Users.

  • When a group of the type board created without associating any organization or team, users can not be added to this board (group). Only the user whose credentials are used to create the board can be added.

  • As there is no concept of users under an account under Trello, the get users operation is achieved by retrieving members of the groups (organizations and boards) to which the user (whose credentials are used for authorizing the API requests) has access.

  • As there are no APIs to retrieve all users or groups, it is required to use /search API by setting the query with characters from [a-z] and [0-9]. This introduces a performance hit.

  • Both organizations and boards of Trello are considered as groups in the connector. Boards can be associated with organizations but organizations cannot be associated with boards.

  • A board cannot be added under organization via group membership operations. Instead, board can be associated with the organization by providing the organization id while performing create or update operation.

  • While performing the group membership operation, removal of membership of a user, whose credentials are used for the authorization of the connector, from the group (organization or board) , will not be executed because after removing membership, any operation on that particular group cannot be performed with these credentials, as the user is unauthorized.

  • While performing group membership operation, removal of the membership of a user who is the only admin of the group (organization or board), is not possible as the group requires at least one admin.

  • Group update or deletion of a group (organization or board) is not possible if the user whose credentials are used to authorize the connector is not the admin of the particular group.

  • All users would be added as normal users for group membership management operations.

  • While performing the update of an organization (group) with the short name and invalid id, Trello initially checks for the uniqueness of the short name and then checks for the existence of the id.

  • All group memberships are of the users type.

  • A board can only be associated with a single organization. Disassociation of a board from organization is not possible. Hence, the group membership does not support addition or removal of boards as a member of the organization.

    IMPORTANT: Please note the important points below:

    • If the Organization short name is available, it has to be unique.

    • While creating a group (of type either organization or board), the user will be a member of the group by default, whose credentials are used for the connector authorization.

    • The type property will not be returned as a group response. To differentiate the group type, the id of the group will be appended with @o or @b for organization type or board type respectively.

    • While creating a group, it is necessary to provide a property type in group extension to differentiate the type of the group (organization or board) that is created. The type property takes values o or b for organization and board respectively. If the type is not provided, it will be assumed as o.

Statuspage

Statuspage is a status and incident communication tool that helps service providers keep customers and employees informed during downtime. It lets users add separate components for each part of the infrastructure or functional part of service.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • API key (user API key under Manage Account → API tab) for the cloud account

  • Organization Id (Organization Id under Manage Account → API tab) for the cloud account

  • Target URL of the cloud account

Supported Objects and Operations

Users
Table 33: Supported operations for Users

Operation

VERB

Create User

POST

Delete User

DELETE

Groups

Not Applicable

Mandatory Fields

Users

  • emails.value

  • password
Groups

Not Applicable

Connector Limitations

  • Update operation for Users, resource type Groups and Pagination are not supported.

  • Retrieving a specific user would be relatively slow due to API limitations.

SAP Cloud Platform

SAP Cloud Platform is an open Platform as a Service (PaaS) that offers users in-memory capabilities, core platform services, and business services for cloud applications.

IMPORTANT: This connector is provided as a preview to the customers. The connector is not completely tested and may not function as expected with Active Roles.

Supervisor Configuration Parameters

To configure the connector, following parameters are required:

  • Connector name

  • Username

  • Password

  • SCIM URL

Supported Objects and Operations

Users
Table 34: Supported operations for Users

Operation

VERB

Create

POST

Update (Id)

PUT

Delete (Id)

DELETE

Get (Id)

GET

Get

GET

Pagination GET
Groups
Table 35: Supported operations for Groups

Operation

VERB

Create

POST

Update (Id)

PUT

Delete  (Id)

DELETE

Get (Id)

GET

Get

GET

Mandatory Fields

Users
  • Email
  • Username
Groups
  • Group Name
  • Display Name

Connector Limitations

  • A performance impact is expected, with a list response of Groups because each record is retrieved and counted, since SCP Groups APIs do not provide totalResults.

  • ServiceProviderAuthority contains only Id field with the same value as the tenant id of the SCP instance, as there are no APIs that can fetch the tenant details in SCP.

  • Get All Groups and Get particular group with ID operations do not retrieve Created and Last Modified fields for Groups object types.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating