Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Rename platform application #560

Merged
merged 2 commits into from
Jan 13, 2025
Merged

docs: Rename platform application #560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd90610
docs: Rename platform application
congminh1254 Jan 13, 2025
155b2e0
Merge branch 'main' into rename-platform-application
congminh1254 Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,21 @@ Among other features, Box CLI includes the following functionality:
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Getting Started](#getting-started)
- [CLI Installation](#cli-installation)
- [CLI and Server Authentication with JWT](#cli-and-server-authentication-with-jwt)
- [Usage](#usage)
- [Box CLI](#box-cli)
- [Table of contents](#table-of-contents)
- [Getting Started](#getting-started)
- [CLI Installation](#cli-installation)
- [Windows \& macOS Installers](#windows--macos-installers)
- [Linux \& Node install](#linux--node-install)
- [CLI and Server Authentication with JWT](#cli-and-server-authentication-with-jwt)
- [Usage](#usage)
- [Command Topics](#command-topics)
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
- [Versions](#versions)
- [Supported Version](#supported-version)
- [Version schedule](#version-schedule)
- [Contributing to the Box CLI](#contributing-to-the-box-cli)
- [Copyright and License](#copyright-and-license)
- [Questions, Bugs, and Feature Requests?](#questions-bugs-and-feature-requests)
- [Versions](#versions)
- [Supported Version](#supported-version)
- [Version schedule](#version-schedule)
- [Contributing to the Box CLI](#contributing-to-the-box-cli)
- [Copyright and License](#copyright-and-license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -62,7 +66,7 @@ npm install --global @box/cli
### CLI and Server Authentication with JWT

Alternatively, to get started with the Box CLI, [download and install](#CLI-Installation) CLI, set up a Box application using Server Authentication with JWT and
download the JSON configuration file from the Configuration page of your app in the
download the JSON configuration file from the Configuration page of your platform app in the
[Box Developer Console][dev-console] following [JWT CLI Guide][jwt-guide]. Then, set up the CLI by pointing it to your configuration file:

```sh-session
Expand Down
4 changes: 2 additions & 2 deletions examples/Mass Update User Zones/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ If you would like to use Admin Console for zone assignment, see [here](https://s
PS /Users/mikechen>
```

4. Setting up the CLI requires creating a Box application that uses server authentication with JWT. See the [Box CLI Using JWT Authentication][jwt-cli] page for instructions.
* The Box application must have the following application **access level** enabled in the configuration page: `App + Enterprise Access`
4. Setting up the CLI requires creating a Box platform application that uses server authentication with JWT. See the [Box CLI Using JWT Authentication][jwt-cli] page for instructions.
* The Box platform application must have the following application **access level** enabled in the configuration page: `App + Enterprise Access`
* The Box application must have the following **application scopes** enabled in the configuration page: `Manage Enterprise Properties`, `Manage Users`
* The Box application must have the following **advanced features** enabled in the configuration page: `Generate User Access Tokens`

Expand Down
Loading