Skip to content

Commit d175be0

Browse files
authored
Change name: custom app to platform app (#673)
* Change name: custom app to platform app * rename custom app to platform app * linter
1 parent b3c3990 commit d175be0

33 files changed

Lines changed: 71 additions & 71 deletions

File tree

content/guides/applications/app-types/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ alias_paths:
77
- /docs/get-started-with-the-box-api
88
- /docs/app-management
99
- /docs/configuring-box-platform
10-
- /guides/applications/custom-apps/
10+
- /guides/applications/platform-apps
1111
- /guides/applications/limited-access-apps/
1212
- /guides/applications/custom-skills/
1313
---
@@ -33,7 +33,7 @@ create.
3333
[jwt]: g://authentication/jwt
3434
[apptoken]: g://authentication/app-token
3535
[devtoken]: g://authentication/tokens/developer-tokens
36-
[custom-apps]: g://applications/app-types/custom-apps
36+
[custom-apps]: g://applications/app-types/platform-apps
3737
[custom-skills]: g://applications/app-types/custom-skills
3838
[ccg]: g://authentication/client-credentials
3939
[laa]: g://applications/app-types/limited-access-apps

content/guides/applications/app-types/custom-apps.md renamed to content/guides/applications/app-types/platform-apps.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ related_guides:
1212
- authentication/client-credentials
1313
---
1414

15-
# Custom App
15+
# Platform App
1616

17-
Custom Apps encompass most use cases and is the most flexible application type.
17+
Platform Apps encompass most use cases and is the most flexible application type.
1818

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

2424
## Authentication methods
2525

26-
Custom Apps support [OAuth 2.0][oauth2], [JWT][jwt], and
26+
Platform Apps support [OAuth 2.0][oauth2], [JWT][jwt], and
2727
[Client Credentials Grant][cc].
2828

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

3333
## When to use
3434

35-
A Custom App is best used when the application:
35+
A Platform App is best used when the application:
3636

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

4343
## Use cases
4444

45-
Example use cases for a Custom App include:
45+
Example use cases for a Platform App include:
4646

4747
- 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.
4848

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

5353
- 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.
5454

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

5959
## Approval
6060

61-
Custom Apps may require approval before use.
61+
Platform Apps may require approval before use.
6262

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

6767
[oauth2]: g://authentication/oauth2

content/guides/applications/app-types/select.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,18 @@ You cannot change this selection later on.
2222
![App Type Selection](images/select-app-type.png)
2323
</ImageFrame>
2424

25-
## Custom App
25+
## Platform App
2626

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

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

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

3838
## Limited Access App
3939

@@ -65,7 +65,7 @@ from files uploaded to Box.
6565
[oauth2]: g://authentication/oauth2
6666
[jwt]: g://authentication/jwt
6767
[app-token]: g://authentication/app-token
68-
[custom-apps]: g://applications/app-types/custom-apps
68+
[custom-apps]: g://applications/app-types/platform-apps
6969
[dev-console]: https://app.box.com/developers/console
7070
[view-app]: g://embed/box-view
7171
[ccg]: g://authentication/client-credentials

content/guides/applications/web-app-integrations/configure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ notes: |-
1414

1515
# Create Web App Integration
1616

17-
This guide explains how to set up a Web App Integration with a Custom App.
17+
This guide explains how to set up a Web App Integration with a Platform App.
1818

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

2727
## Create an OAuth 2.0 Application
2828

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

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

144-
[ca]: g://applications/app-types/custom-apps
144+
[ca]: g://applications/app-types/platform-apps
145145
[pu]: g://applications/web-app-integrations/types
146146
[uid]: page://platform/appendix/locating-values/#user-ids
147147
[fid]: page://platform/appendix/locating-values/#content-ids

content/guides/authentication/app-token/app-token-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ related_guides:
99
- authorization/custom-app-approval
1010
required_guides:
1111
- authentication/select
12-
- applications/app-types/custom-apps
12+
- applications/app-types/platform-apps
1313
related_resources: []
1414
alias_paths:
1515
- /guides/applications/app-types/custom-apps/app-token-setup

content/guides/authentication/client-credentials/client-credentials-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ alias_paths:
1818

1919
## Prerequisites
2020

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

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

3232
### Select application type
3333

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

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

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

9494
## Basic configuration

content/guides/authentication/client-credentials/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ verify your application's identity using a client ID and client secret.
2020

2121
## Prerequisites
2222

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

content/guides/authentication/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ console.
1515

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

@@ -42,7 +42,7 @@ curl https://api.box.com/2.0/users/me \
4242
[jwt]: g://authentication/jwt
4343
[apptoken]: g://authentication/app-token
4444
[devtoken]: g://authentication/tokens/developer-tokens
45-
[custom-app]: g://applications/app-types/custom-apps
45+
[custom-app]: g://applications/app-types/platform-apps
4646
[custom-skill]: g://applications/app-types/custom-skills
4747
[la]: g://applications/app-types/select/#limited-access-app
4848
[ccg]: g://authentication/client-credentials

content/guides/authentication/jwt/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ designed to allow powerful server-to-server authentication.
2222
![The JWT flow](./jwt-flow.png)
2323
</ImageFrame>
2424

25-
Server-side authentication using JWT is only available to the Custom Application
25+
Server-side authentication using JWT is only available to the Platform Application
2626
[app type][app-type]. This authentication method does not require end-user
2727
interaction and, if granted the proper privileges, can be used
2828
to act on behalf of any user in an enterprise.

content/guides/authentication/jwt/jwt-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ related_guides:
55
- authentication/jwt
66
required_guides:
77
- authentication/select
8-
- applications/app-types/custom-apps
8+
- applications/app-types/platform-apps
99
- authorization/custom-app-approval
1010
related_resources: []
1111
alias_paths:

0 commit comments

Comments
 (0)