Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions content/guides/applications/app-types/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ alias_paths:
- /docs/get-started-with-the-box-api
- /docs/app-management
- /docs/configuring-box-platform
- /guides/applications/custom-apps/
- /guides/applications/platform-apps
- /guides/applications/limited-access-apps/
- /guides/applications/custom-skills/
---
Expand All @@ -33,7 +33,7 @@ create.
[jwt]: g://authentication/jwt
[apptoken]: g://authentication/app-token
[devtoken]: g://authentication/tokens/developer-tokens
[custom-apps]: g://applications/app-types/custom-apps
[custom-apps]: g://applications/app-types/platform-apps
[custom-skills]: g://applications/app-types/custom-skills
[ccg]: g://authentication/client-credentials
[laa]: g://applications/app-types/limited-access-apps
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,18 @@ related_guides:
- authentication/client-credentials
---

# Custom App
# Platform App

Custom Apps encompass most use cases and is the most flexible application type.
Platform Apps encompass most use cases and is the most flexible application type.

A custom application typically presents Box functionality to a user within a
A platform application typically presents Box functionality to a user within a
custom interface. Box offers pre-built, customizable user interface components,
known as [UI Elements][uie], for functionality like browsing, searching, and
previewing content.

## Authentication methods

Custom Apps support [OAuth 2.0][oauth2], [JWT][jwt], and
Platform Apps support [OAuth 2.0][oauth2], [JWT][jwt], and
[Client Credentials Grant][cc].

<CTA to='g://authentication/select'>
Expand All @@ -32,7 +32,7 @@ Custom Apps support [OAuth 2.0][oauth2], [JWT][jwt], and

## When to use

A Custom App is best used when the application:
A Platform App is best used when the application:

- Wants to use [OAuth 2.0][oauth2], [JWT][jwt] or [Client Credentials Grant][cc] for authentication.
- Wants to upload and download files
Expand All @@ -42,13 +42,13 @@ A Custom App is best used when the application:

## Use cases

Example use cases for a Custom App include:
Example use cases for a Platform App include:

- A file vault in an application that allows an end user to access files that have been shared with them, while also providing access for employees to the same files through the Box Web app.

An example of this is financial advisor sharing statements and investment
prospectuses with investors that can be viewed and commented on within a
custom application.
platform application.

- A file upload feature in an application that allows an end user to submit and upload files from within a custom-built application to Box. These uploads then initiate a business process with the Box Web app.

Expand All @@ -58,10 +58,10 @@ Example use cases for a Custom App include:

## Approval

Custom Apps may require approval before use.
Platform Apps may require approval before use.

<CTA to='g://authorization/custom-app-approval'>
Learn how to approve Custom Apps
Learn how to approve Platform Apps
</CTA>

[oauth2]: g://authentication/oauth2
Expand Down
8 changes: 4 additions & 4 deletions content/guides/applications/app-types/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ You cannot change this selection later on.
![App Type Selection](images/select-app-type.png)
</ImageFrame>

## Custom App
## Platform App

| | |
| -------------------------- | ---------------------------------------------------------------------------- |
| **Authentication methods** | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Authentication][ccg] |
| **Notable Features** | Webhooks, Integrations, and Web App Integrations |

Custom App encompasses most use cases and is the most flexible option.
Platform App encompasses most use cases and is the most flexible option.
This application type allows for interaction with our 150+ endpoints.
For example, downloading/uploading, searching, applying metadata and more.

<CTA to="g://applications/app-types/custom-apps">Learn more about Custom Apps</CTA>
<CTA to="g://applications/app-types/platform-apps">Learn more about Platform Apps</CTA>

## Limited Access App

Expand Down Expand Up @@ -65,7 +65,7 @@ from files uploaded to Box.
[oauth2]: g://authentication/oauth2
[jwt]: g://authentication/jwt
[app-token]: g://authentication/app-token
[custom-apps]: g://applications/app-types/custom-apps
[custom-apps]: g://applications/app-types/platform-apps
[dev-console]: https://app.box.com/developers/console
[view-app]: g://embed/box-view
[ccg]: g://authentication/client-credentials
6 changes: 3 additions & 3 deletions content/guides/applications/web-app-integrations/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ notes: |-

# Create Web App Integration

This guide explains how to set up a Web App Integration with a Custom App.
This guide explains how to set up a Web App Integration with a Platform App.

<message type='warning'>
Server-side integration is no longer supported.
Expand All @@ -26,7 +26,7 @@ You will be able to deactivate them and change the implementation to a new one.

## Create an OAuth 2.0 Application

Navigate to the [Developer Console][devconsole] and create a [Custom App][ca]
Navigate to the [Developer Console][devconsole] and create a [Platform App][ca]
that leverages [OAuth 2.0 authentication][custom-oauth2].

## Create a New Integration
Expand Down Expand Up @@ -141,7 +141,7 @@ note that the URL must be publicly accessible on the internet.
To make a Box integration publicly available it needs to be listed in the App
Center. Follow the [Integrations][integrations] guide for more details.

[ca]: g://applications/app-types/custom-apps
[ca]: g://applications/app-types/platform-apps
[pu]: g://applications/web-app-integrations/types
[uid]: page://platform/appendix/locating-values/#user-ids
[fid]: page://platform/appendix/locating-values/#content-ids
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/app-token/app-token-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ related_guides:
- authorization/custom-app-approval
required_guides:
- authentication/select
- applications/app-types/custom-apps
- applications/app-types/platform-apps
related_resources: []
alias_paths:
- /guides/applications/app-types/custom-apps/app-token-setup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ alias_paths:

## Prerequisites

To set up a Custom App using server-side authentication, you will need to ensure
To set up a Platform App using server-side authentication, you will need to ensure
you have access to the [Developer Console][devconsole] from your Box enterprise
account. Alternatively, you may sign up for a [developer account][devaccount].

Expand All @@ -31,7 +31,7 @@ Select **Create Platform App**.

### Select application type

Select **Custom App** from the list of application types. A modal will appear to
Select **Platform App** from the list of application types. A modal will appear to
prompt a selection for the next step.

<ImageFrame border>
Expand Down Expand Up @@ -88,7 +88,7 @@ approval. More information on this process is available in our
[authorization guide][app-auth].

<CTA to='g://authorization/custom-app-approval'>
Learn how to authorize a Custom Application
Learn how to authorize a Platform Application
</CTA>

## Basic configuration
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/client-credentials/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ verify your application's identity using a client ID and client secret.

## Prerequisites

- A Custom Application using Server Authentication (with Client Credentials Grant) authentication in the Box [Developer Console][devconsole]
- A Platform Application using Server Authentication (with Client Credentials Grant) authentication in the Box [Developer Console][devconsole]
- [2FA][2fa] enabled on your Box account for viewing and copying the application's client secret from the configuration tab
- The application is [authorized][auth] in the Box Admin Console

Expand Down
4 changes: 2 additions & 2 deletions content/guides/authentication/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ console.

| Box Application Type | Authentication methods |
| ---------------------------- | ------------------------------------------------------------------- |
| [Custom App][custom-app] | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Grant][ccg] |
| [Platform App][custom-app] | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Grant][ccg] |
| [Limited Access App][la] | [App token][apptoken] |
| [Custom Skill][custom-skill] | No authentication method selection needed |

Expand All @@ -42,7 +42,7 @@ curl https://api.box.com/2.0/users/me \
[jwt]: g://authentication/jwt
[apptoken]: g://authentication/app-token
[devtoken]: g://authentication/tokens/developer-tokens
[custom-app]: g://applications/app-types/custom-apps
[custom-app]: g://applications/app-types/platform-apps
[custom-skill]: g://applications/app-types/custom-skills
[la]: g://applications/app-types/select/#limited-access-app
[ccg]: g://authentication/client-credentials
2 changes: 1 addition & 1 deletion content/guides/authentication/jwt/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ designed to allow powerful server-to-server authentication.
![The JWT flow](./jwt-flow.png)
</ImageFrame>

Server-side authentication using JWT is only available to the Custom Application
Server-side authentication using JWT is only available to the Platform Application
[app type][app-type]. This authentication method does not require end-user
interaction and, if granted the proper privileges, can be used
to act on behalf of any user in an enterprise.
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/jwt/jwt-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ related_guides:
- authentication/jwt
required_guides:
- authentication/select
- applications/app-types/custom-apps
- applications/app-types/platform-apps
- authorization/custom-app-approval
related_resources: []
alias_paths:
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/jwt/without-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ using a public and private key pair.

### Prerequisites

- A Custom Application using JWT authentication within the [Developer Console][devconsole]
- A Platform Application using JWT authentication within the [Developer Console][devconsole]
- A private key configuration file named `config.json`, which can be downloaded from the configuration tab of the [Developer Console][devconsole]
- Ensure your application is [authorized][auth] within the Box Admin Console

Expand Down
8 changes: 4 additions & 4 deletions content/guides/authentication/oauth2/oauth2-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ related_guides:
- authentication/oauth2/oauth2-setup
required_guides:
- authentication/select
- applications/app-types/custom-apps
- applications/app-types/platform-apps
related_resources: []
alias_paths:
- /docs/setting-up-an-oauth-app
Expand All @@ -15,15 +15,15 @@ alias_paths:

# Setup with OAuth 2.0

A Custom App can be set up to use client-side [OAuth 2.0][oauth2] authentication.
A Platform App can be set up to use client-side [OAuth 2.0][oauth2] authentication.

<CTA to='g://authentication/oauth2'>
Learn how OAuth 2.0 authentication works
</CTA>

## Prerequisites

To set up a Custom App using OAuth 2.0 authentication, you will need to ensure
To set up a Platform App using OAuth 2.0 authentication, you will need to ensure
you have access the [Developer Console][devconsole] from your Box enterprise
account. Alternatively, you may sign up for a [developer account][devaccount].

Expand All @@ -36,7 +36,7 @@ Log into Box and go to the

### Select application type

Select **Custom App** from the list of application types. A modal will appear to
Select **Platform App** from the list of application types. A modal will appear to
prompt a selection for the next step.

<ImageFrame border>
Expand Down
2 changes: 1 addition & 1 deletion content/guides/authentication/oauth2/without-sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ using the `as-user` header.

Before continuing you will need to complete the following steps:

- Create a Custom App within the Box Developer Console, which leverages the OAuth 2.0 authentication method.
- Create a Platform App within the Box Developer Console, which leverages the OAuth 2.0 authentication method.
- Navigate to the configuration tab for the application to copy the `client_id` and `client_secret` values.
- Ensure at least one redirect URI is configured in the configuration tab for the application.

Expand Down
4 changes: 2 additions & 2 deletions content/guides/authentication/select.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following authorization methods are available to each Box application type.

| Box Application Type | Supports OAuth 2.0? | JWT? | Client Credentials? | App Token? |
| ---------------------------- | ------------------- | ---- | ------------------- | ---------- |
| [Custom App][custom-app] | Yes | Yes | Yes | No |
| [Platform App][custom-app] | Yes | Yes | Yes | No |
| [Limited Access App][la-app] | No | No | No | Yes |
| [Custom Skill][custom-skill] | No | No | No | No |

Expand Down Expand Up @@ -157,6 +157,6 @@ authentication the token defaults to the application's Service Account.

</Message>

[custom-app]: g://applications/app-types/custom-apps
[custom-app]: g://applications/app-types/platform-apps
[custom-skill]: g://applications/app-types/custom-skills
[la-app]: g://applications/app-types/limited-access-apps
14 changes: 7 additions & 7 deletions content/guides/authentication/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ related_guides:
- authentication/oauth2
- authentication/jwt
- authentication/app-token
- applications/app-types/custom-apps
- applications/app-types/platform-apps
- applications/app-types/custom-skills
required_guides: []
related_resources: []
Expand All @@ -19,9 +19,9 @@ Many Box Enterprises use **Single Sign On** (SSO) to authenticate
Box Platform interact with an SSO provider depends on the type of application
being built.

## Custom Apps with Client-side Authentication
## Platform Apps with Client-side Authentication

When users authenticate with a [Custom App][custom_app] configured to use
When users authenticate with a [Platform App][custom_app] configured to use
[OAuth 2.0][oauth2] Box will detect if the enterprise is configured to use SSO.
If it is, Box will redirect the user to their browser and display the
enterprise's configured SSO log-in screen.
Expand All @@ -47,14 +47,14 @@ having a Box account matching the email address passed via SAML.
set to required, even if it is only used for platform use cases.
</Message>

## Custom Apps with Server-side Authentication
## Platform Apps with Server-side Authentication

For [Custom Apps][custom_app] that use [JWT][jwt] or
For [Platform Apps][custom_app] that use [JWT][jwt] or
[Client Credentials Grant][ccg] and
[Limited Access Apps][la-app] that use [App Token][app_token] authentication,
SSO is not used to authenticate with Box.

Custom Apps using server-side authentication only use server-to-server API
Platform Apps using server-side authentication only use server-to-server API
calls to communicate with Box. In this scenario, the way in which an end user
is authenticated is determined by the application and not by Box.

Expand Down Expand Up @@ -89,6 +89,6 @@ therefore SSO is not involved.
[ccg]: g:///authentication/client-credentials
[la-app]: guide://applications/web-app-integrations
[app_token]: g://authentication/app-token
[custom_app]: g://applications/app-types/custom-apps
[custom_app]: g://applications/app-types/platform-apps
[custom_skills]: g://applications/app-types/custom-skills
[jwt]: g://authentication/jwt/jwt-setup
6 changes: 3 additions & 3 deletions content/guides/authentication/tokens/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,9 @@ Token.

| Box Application Type | How to get Access Token |
| ------------------------------------- | ------------------------------------------------ |
| Custom App + OAuth 2.0 | [Explicit user grant][oauth2-with-sdk] |
| Custom App + JWT | [Exchange a JWT assertion][jwt-with-sdk] |
| Custom App + Client Credentials Grant | [Use client ID and client secret][clientcred] |
| Platform App + OAuth 2.0 | [Explicit user grant][oauth2-with-sdk] |
| Platform App + JWT | [Exchange a JWT assertion][jwt-with-sdk] |
| Platform App + Client Credentials Grant | [Use client ID and client secret][clientcred] |
| Limited Access App + App Token | Configure token in [Developer Console][devcon] |
| Custom Skill | Access Token in event payload |

Expand Down
4 changes: 2 additions & 2 deletions content/guides/authorization/custom-app-approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ alias_paths:
- /guides/applications/custom-apps/app-approval
---

# Custom App Approval
# Platform App Approval

Server authentication applications using [JWT][jwt] or
[Client Credentials Grant][ccg] must be authorized by a Box Admin before use.
Expand All @@ -31,7 +31,7 @@ the authorization and enablement status of your application.
## Approval Notifications

A semi-automated process to submit an app approval is available in the Developer
Console for all custom application types.
Console for all platform application types.

### Server authentication apps

Expand Down
4 changes: 2 additions & 2 deletions content/guides/authorization/platform-app-approval.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ copy it using the `copy` button.
### As an Admin

1. Navigate to the [Admin Console][adminconsole] and select the **Apps** tab (1) from the left navigation panel.
2. Click the **Custom Apps Manager** tab (2) at the top of your screen.
2. Click the **Platform Apps Manager** tab (2) at the top of your screen.
3. For both Server and User Authentication Apps screens, click the **Add App** (3) button in the top right corner to add a new app.
4. Alternatively, you can use the Custom Apps Manager table menu (4) to authorize and enable apps.
4. Alternatively, you can use the Platform Apps Manager table menu (4) to authorize and enable apps.

#### Server Authentication Apps

Expand Down
2 changes: 1 addition & 1 deletion content/guides/box-ai/ai-tutorials/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ calls.
[token]: g://authentication/tokens/developer-tokens
[scope]: g://api-calls/permissions-and-errors/scopes
[oauthscopes]: g://api-calls/permissions-and-errors/scopes#scopes-oauth-2-authorization
[createapps]: g://applications/app-types/custom-apps
[createapps]: g://applications/app-types/platform-apps
[postman]: g://tooling/postman
[form]: https://forms.gle/Nsh3TwM3W8qg4U35A
[authorization]: g://authorization
Expand Down
2 changes: 1 addition & 1 deletion content/guides/cli/quick-start/1-create-oauth-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ extra steps to set up.

* 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 create a **Platform 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**

Expand Down
Loading