Skip to main content
This guide walks you through obtaining OAuth 2.0 credentials for the Box plugin.

​
Authentication Method

  • oauth_2 - OAuth 2.0 user authentication

​
OAuth 2.0 Setup

​
Step 1: Create a Box App

  1. Go to Box Developer Console
  2. Click Create New App
  3. Select Custom App
  4. Choose Standard OAuth 2.0 as the authentication method
  5. Enter your app name and click Create App

​
Step 2: Configure OAuth Settings

  1. In your app settings, go to the Configuration tab
  2. Under OAuth 2.0 Redirect URI, add your callback URL
    • For CLI flow: http://localhost:<port>
  3. Under Application Scopes, select the required permissions:
    • Read all files and folders stored in Box
    • Write all files and folders stored in Box
  4. Click Save Changes

​
Step 3: Get Client Credentials

  1. In the Configuration tab, copy the Client ID and Client Secret
  2. Store these securely
Storing Credentials: 
pnpm corsair setup --plugin=box client_id=your-client-id client_secret=your-client-secret
pnpm corsair auth --plugin=box
The CLI will print an authorization URL — open it in a browser. Once you approve, tokens are saved automatically.

​
Required Credentials Summary

CredentialRequired ForWhere to Find
Client IDOAuth 2.0Developer Console → App Configuration
Client SecretOAuth 2.0Developer Console → App Configuration
For general information about how Corsair handles authentication, see Authentication.