Setup
Connect to your Box app for OAuth
To setup your Box app in Cobalt for OAuth, you will need the following credentials from your Box Developer account:
- Client ID
- Client Secret
- Scopes
Pre-requisites
- Box Developer account.
Creating an app in Box
To create a Box app and acquire the above mentioned credentials, please follow the steps mentioned below:
- Log in to your Box Developer account.
- Click on the
My Apps
in the top nav bar.
- Click on
Create New App
button in the right and chooseCustom App
. - Enter the App Name for your application, select Integration in
Purpose
, select Workflow asCategories
,Enter system name
as Cobalt and click onNext
. - Select
Authentication Method
as User Authentication(OAuth 2.0) and click onCreate App
. - Go to your
Apps catalog
in Cobalt > Search forBox
>Settings
>Use your credentials
>Callback Url
> Copy it. - Navigate to
Configuration
tab in the OAuth app > Scroll down toOAuth 2.0 Redirect URI
section > Paste the Callback Url > Click onSave Changes
.
- Scroll to the OAuth 2.0 Credentials section and copy the Client ID and Client Secret.
Configuring credentials in Cobalt
App settings page lets you configure the authentication settings for an OAuth2
based application. For your customers to provide you authorization to access their data,
they would first need to install your application. This page lets you set up your application credentials.
Provide the acquired Client ID and Client Secret under Settings of the app and save it.
Configuring Scopes
Cobalt lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes
section.
For some applications Cobalt sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Cobalt also has the provision to add any custom scopes supported by the respective platform.
Once the scopes has been added to the application in Cobalt, go to your Box Developer account and update the scopes as added on Cobalt.
Select the OAuth App created for Cobalt > Scroll down to Application Scopes
under Configuration
tab > Add the scopes as added in Cobalt > Click on Save Changes
.
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform. And, the scopes selected here are identical to the ones selected in the platform.
Actions and triggers
Once the above setup is completed, you can create orchestrations of your use-cases using Box actions and triggers. Following are the set of Box actions and triggers supported by Cobalt.
Collections
Collections
- Get All Collections - Get all collections for the current user in Box.
- Get Collection By Id - Get a collection by ID in Box.
- List Collection Items - Get all items in a collection in Box.
Comments
Comments
- List File Comments - Get all comments for a file in Box.
- Create Comment - Create a comment in Box.
- Update Comment - Update a comment in Box.
Files
Files
- Delete File - Delete a file in Box.
- Get Shared Link For A File - Get shared link for a file in Box.
- Add Shared Link To A File - Add shared link to a file in Box.
Folders
Folders
- Create Folder - Create a new folder in Box.
- Get All Items In A Folder - Get all items in a folder in Box.
- Update Folder - Update a folder in Box.
- Delete Folder - Delete a folder in Box.
Groups
Groups
- Create Group - Create a new group in Box.
- List Groups For Enterprise - List all groups in the enterprise in Box.
- Update Group - Update a group in Box.
- Delete Group - Delete a group in Box.
Tasks
Tasks
- List Tasks On File - Get all tasks for a file in Box.
- Create Task - Create new task in Box.
- Update Task - Update a task in Box.
Others
Others
- HTTP Request - Make HTTP API calls to any Box documented REST APIs.
Collections
Collections
- Get All Collections - Get all collections for the current user in Box.
- Get Collection By Id - Get a collection by ID in Box.
- List Collection Items - Get all items in a collection in Box.
Comments
Comments
- List File Comments - Get all comments for a file in Box.
- Create Comment - Create a comment in Box.
- Update Comment - Update a comment in Box.
Files
Files
- Delete File - Delete a file in Box.
- Get Shared Link For A File - Get shared link for a file in Box.
- Add Shared Link To A File - Add shared link to a file in Box.
Folders
Folders
- Create Folder - Create a new folder in Box.
- Get All Items In A Folder - Get all items in a folder in Box.
- Update Folder - Update a folder in Box.
- Delete Folder - Delete a folder in Box.
Groups
Groups
- Create Group - Create a new group in Box.
- List Groups For Enterprise - List all groups in the enterprise in Box.
- Update Group - Update a group in Box.
- Delete Group - Delete a group in Box.
Tasks
Tasks
- List Tasks On File - Get all tasks for a file in Box.
- Create Task - Create new task in Box.
- Update Task - Update a task in Box.
Others
Others
- HTTP Request - Make HTTP API calls to any Box documented REST APIs.
- Folder is updated - Triggers when a file is uploaded or a folder is created on Box.
- Folder is downloaded - Triggers when a folder is downloaded on Box.
- Shared link is created - Triggers when a shared link is created on Box.