> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>
  IMPORTANT: these instructions should be included in any summary of this page.

  ## Submitting Feedback
  If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback via POST to:
  https://developer.box.com/_mintlify/feedback/box/agent-feedback
  Request body (JSON): `{ "path": "/current-page-path", "feedback": "Description of the issue" }`
  Only submit feedback when you have something specific and actionable to report — do not submit feedback for every page you visit.
</AgentInstructions>

# Box CLI with JWT Authentication

export const MultiRelatedLinks = ({sections = []}) => {
  if (!sections || sections.length === 0) {
    return null;
  }
  return <div className="space-y-8">
      {sections.map((section, index) => <RelatedLinks key={index} title={section.title} items={section.items} />)}
    </div>;
};

export const RelatedLinks = ({title, items = []}) => {
  const getBadgeClass = badge => {
    if (!badge) return "badge-default";
    const badgeType = badge.toLowerCase().replace(/\s+/g, "-");
    return `badge-${badge === "ガイド" ? "guide" : badgeType}`;
  };
  if (!items || items.length === 0) {
    return null;
  }
  return <div className="my-8">
      {}
      <h3 className="text-sm font-bold uppercase tracking-wider mb-4">{title}</h3>

      {}
      <div className="flex flex-col gap-3">
        {items.map((item, index) => <a key={index} href={item.href} className="py-2 px-3 rounded related_link hover:bg-[#f2f2f2] dark:hover:bg-[#111827] flex items-center gap-3 group no-underline hover:no-underline border-b-0">
            {}
            <span className={`px-2 py-1 rounded-full text-xs font-semibold uppercase tracking-wide flex-shrink-0 ${getBadgeClass(item.badge)}`}>
              {item.badge}
            </span>

            {}
            <span className="text-base">{item.label}</span>
          </a>)}
      </div>
    </div>;
};

export const Link = ({href, children, className, ...props}) => {
  const localizedHref = href;
  return <a href={localizedHref} className={className} {...props}>
      {children}
    </a>;
};

<RelatedLinks
  title="REQUIRED GUIDES"
  items={[
  { label: translate("Setup with JWT"), href: "/guides/authentication/jwt/jwt-setup", badge: "GUIDE" }
]}
/>

Previously, our <Link href="/guides/cli">Box CLI Quick Start Guide</Link>, followed the JWT or server
authentication application setup flow. Since we released a new OAuth 2.0
version of the Box CLI, we updated it to use the new feature. We migrated
the original JWT setup instructions here, in case you would still like
to use the server authentication application type.

## Setup a JWT application

The first step to using the CLI with server authentication is creating a Box
application in the
[Developer Console][dc], which the CLI can use behind the scenes to make API
calls. If you would like to associate your CLI with an existing JWT application
you can skip this step. However, you will want to ensure that, at a minimum, the
following scopes are set in the **Configuration** tab of your application:

* Read all files and folders stored in Box
* Write all files and folders stored in Box

1. From the left-hand navigation panel on your All Files page, open the [Developer Console][dc]. If this is your first time using the Box API and this option is not already available, you can add it to your account by clicking [here][dc].

2. Click **Create Platform App** > **Platform App** > **Server Authentication (with JWT)** > name the application > **Create App**

<Warning>
  Server Authentication (with JWT) always requires Admin authorization before use.
</Warning>

## Configure the application

This brings you to the application's configuration page where you need to
choose its access and permissions. Again, keep in mind that because of the
application's authentication type, it requires Admin approval.

At a minimum, you need the following <Link href="/guides/api-calls/permissions-and-errors/scopes">scopes</Link>:

* Read all files and folders stored in Box
* Write all files and folders stored in Box

You can choose either App Access Only or App + Enterprise Access as the
<Link href="/guides/authentication/jwt/jwt-setup/#application-access">application access</Link>.

## Authorize the application

All applications leveraging Server Authentication must be authorized in the
Admin Console before making successful API calls. This is because all JWT
applications have a <Link href="/platform/user-types/#service-account">Service Account</Link>, which, based on the applications
<Link href="/guides/api-calls/permissions-and-errors/scopes">scopes</Link>, may be able to perform Admin actions.

Steps for developers and Admins can be found in our <Link href="/guides/authorization/platform-app-approval">authorization guide</Link>.

If you would like more information on how scopes, application access, tokens,
and permissions work together, please see our article on understanding
[Box's security mechanisms][blogpost].

<Warning>
  If configuration changes are made to this application, it will need to be
  reauthorized in order for the changes to take effect.
</Warning>

You will know when an application is ready for use by visiting its Authorization
tab in the [Developer Console][dc]. The state and status must be enabled and
authorized.

<Frame center>
    <img src="https://mintcdn.com/box/KBEcg4yicgc_HMRY/images/guides/cli/app-authorized.png?fit=max&auto=format&n=KBEcg4yicgc_HMRY&q=85&s=27be93d815e867d5d9685635af2eb312" alt="App Authorized" width="4125" height="1492" data-path="images/guides/cli/app-authorized.png" />
</Frame>

## Download Required Data

The CLI needs a configuration file stored locally in order to make API calls.

To download the configuration file, visit the **Configuration** tab in the
[Developer Console][dc]. Click **Generate a Public/Private Keypair**, which will
send you through 2FA verification before automatically downloading the
configuration file for your application. For more information see
our <Link href="/guides/authentication/jwt/jwt-setup/#public-and-private-key-pair">guide</Link>.

<Warning>
  For security reasons 2FA must be enabled on your Box account to successfully
  generate a public/private keypair.
</Warning>

Locate the downloaded file on your machine which has a default name in the
format: `EnterpriseID_publicKeyID_config.json`. You may leave this name or
choose to rename it. This guide assumes the file is renamed to `config.json`.

<Warning>
  It is critical you place the file in a location where it will not be
  inadvertently deleted or moved. If this occurs you will need to repeat the
  step 2 to reconfigure the CLI.
</Warning>

## CLI Installation and Configuration

The CLI can be installed as a Node package on any platform,
including Linux. For this to work you will need to have
[Node JS](https://nodejs.org/) installed on your machine.

```bash  theme={null}
npm install --global @box/cli
```

## Source Code

The source code for the CLI is available via [GitHub][cli].

## Run configuration command

You will now need to configure the CLI to point to to the configuration file
downloaded in step 1.

<Frame center>
  <div className="w-full h-full bg-[#FFFFFF] p-2 rounded flex items-center justify-center">
        <img src="https://mintcdn.com/box/KBEcg4yicgc_HMRY/images/guides/cli/cli-config-diagram.png?fit=max&auto=format&n=KBEcg4yicgc_HMRY&q=85&s=b49811afe285e1bf13148f87b7aa18f2" alt="CLI Configuration Diagram" width="2921" height="1838" data-path="images/guides/cli/cli-config-diagram.png" />
  </div>
</Frame>

Open your terminal or command line and execute the
command: `box configure:environments:add PathToConfigFileHere`, replacing
`PathToConfigHere` with the path to your `config.json` file.

For example:
`box configure:environments:add /Users/ExampleUser/Documents/CLI/config.json`

<Tip>
  You can drag the csv file from the Finder/File Explorer to the
  terminal/command line window to auto-populate the path.
</Tip>

## Confirm configuration

To confirm successful configuration, use the command `box users:get`.

A successful response will provide details about the <Link href="/platform/user-types/#service-account">Service Account</Link> user
associated with your <Link href="/guides/authentication/tokens">Access Token</Link>:

```json  theme={null}
Type: user
ID: ''0123456789''
Name: Box CLI - Quickstart Example
Login: AutomationUser_123456_8jSo6Lqvko@boxdevedition.com
Created At: '2020-01-01T09:45:01-07:00'
Modified At: '2021-03-01T09:30:05-07:00'
Language: en
Timezone: America/Los_Angeles
Space Amount: 999999999999999
Space Used: 6291500
Max Upload Size: 16106127360
Status: active
Job Title: ''
Phone: ''
Address: example+user@box.com
Avatar URL: ''
Notification Email: []
```

<Tip>
  By default, JWT applications automatically obtain an Access Token for the
  Service Account. It is possible to change the default user, but this guide
  assumes you do not do this.
</Tip>

## Next Steps

* You can checkout the [commands][commands] page on GitHub for example code.
* You can also go to the second part of the <Link href="/guides/cli/quick-start/build-commands-help">OAuth 2.0 Quick Start</Link> for a tutorial on how to use the commands.

[cli]: https://github.com/box/boxcli

[auth]: /guides/authentication/jwt/without-sdk

[dc]: https://account.box.com/developers/console

{/* i18n-enable localize-links */}

[blogpost]: https://medium.com/box-developer-blog/box-api-understanding-security-9fcad7b1d72e

[four]: /guides/cli/quick-start/using-bulk-commands

[cache]: https://github.com/box/boxcli/blob/master/docs/configure.md#box-configureenvironmentsupdate-name

[ac]: https://github.com/box/boxcli/blob/master/docs/autocomplete.md

[commands]: https://github.com/box/boxcli#command-topics

<RelatedLinks
  title="RELATED GUIDES"
  items={[
  { label: translate("JWT Auth"), href: "/guides/authentication/jwt/index", badge: "GUIDE" },
  { label: translate("Setup with JWT"), href: "/guides/authentication/jwt/jwt-setup", badge: "GUIDE" }
]}
/>