Box Developer Documentation
Log in

Configure a Box App

Guides CLI Use Box CLI with OAuth 2.0 Configure a Box App
Edit this page
123456

Configure a Box App

To use the Box CLI you will need to create a Box App. A Box App is an application that can be used for making API calls. When using the Box CLI you can choose to either set up your own Box App or use our preconfigured one. The key benefit of setting up your own Box App is that you won't need to go through login every hour, but it does require a few extra steps to set up.

Select a Box App to use

Create new Box App

We can set up a Box App for you right here from the documentation. With a few clicks you will be ready to go!

Use existing Box App

If you've already created a Box App before that you want to use, then we can use the credentials for that application.

Create a Box App

To use your own Box App you will need to create a new Box App in the Box Developer Console. Click the button below and we will set it up for you. At the end you will have a Client ID and Client Secret.

Create an appclose

Let us take care of the hard parts for you. Before we can create an app for you we will need you to log in.

Log in

We will use these credentials to authenticate the Box CLI in the next step.

Use existing Box App

If you have already created a Box App before you can use that as well. We require a few settings to be set for this to work.

  1. Go to the Developer Console
  2. Select your application
  3. Go to the application’s Configuration section
  4. Make sure your application uses Standard OAuth 2.0 as the authentication method
  5. Scroll down to the OAuth 2.0 redirect URI configuration and set the Redirect URI to the value http://localhost:3000/callback.
  6. Scroll down to the Application Scopes section to select your desired permissions. Your application must have at least one or more of the following scopes: read all files and folders stored in Box, read and write all files and folders in Box.
  7. At the top of the page click the button to Save Changes

Next, copy the values for the Client ID and Client Secret into these 2 fields.

We will use these credentials to authenticate the Box CLI in the next step.

Security notice

Your API credentials are now stored in the browser cache. We highly recommend clearing out this storage by clicking the Reset button later in this guide.

Summary

  • You either selected to create a new Box App
    • Signed up for a developer account (Optional)
    • Had us create a Custom App for you that uses OAuth 2.0 authentication
    • Had us set up the redirect URL for the application
  • Or you selected to use an existing Box App

I have configured a Box app