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
-
Instance DateTime Offset (refer Configuring additional datetime offset in connectors for more details)
To get the Box credentials
-
Create an account in Box.
-
Log in to the Box account . The URL will be similar to https://{Business_Name}.app.box.com/folder/0.
-
Navigate to the Developer console.
-
Create a new custom application.
-
Select OAuth 2.0 with JWT (server authentication) as the authentication method.
- Enter a relevant name for the application that is to be created.
-
Click View App and navigate to the Configuration section.
-
Set the value of Application Access to Enterprise.
-
Enable the advanced features by selecting the following options:
- Perform action as Users
- Generate User access token
-
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
Operation |
VERB |
---|---|
Create |
POST |
Update |
PUT |
Delete |
DELETE |
Get user by Id |
GET |
Get all users |
GET |
Get all users with pagination |
GET |
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
- DisplayName
- Email ID
Groups
-
DisplayName
User and Group mapping
The user and group mappings are listed in the tables below.
SCIM parameter | Box parameter |
---|---|
id | id |
login | email[0].value |
login | userName |
name | name.formatted |
name | displayName |
status | active |
address | address[0].formatted |
type | userType |
phone | PhoneNumbers[0].Value |
status | active |
job_title | title |
language | preferredLanguage |
timezone | timezone |
created_at | meta.created |
modified_at | meta.lastModified |
emailAliases.entries[].id |
userExtension.additionalEmails[].id |
emailAliases.entries[].email |
userExtension.additionalEmails[].value |
emailAliases.entries[].is_confirmed |
userExtension.additionalEmails[].is_confirmed |
SCIM parameter | Box parameter |
---|---|
id | id |
displayName | name |
created_at | created |
modified_at | lastModified |
user[].id |
members[].value |
user[].name |
members[].display |
There might be a performance impact when you add or remove multiple email aliases since the cloud application processes them one by one.
NOTE: For more information, see Configuring Box connector to support additional email IDs for users