diff --git a/content/guides/applications/app-types/custom-apps.md b/content/guides/applications/app-types/custom-apps.md index f347f4f54..22841869b 100644 --- a/content/guides/applications/app-types/custom-apps.md +++ b/content/guides/applications/app-types/custom-apps.md @@ -37,7 +37,7 @@ A Custom 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 - Wants the freedom to access both their own files, as well as files owned by [managed or external users][users]. -- Wants the option to list the application in the Box App Center +- Wants the option to list the application in the Box Integrations - Wants to provide integration into the Box Web App ## Use cases diff --git a/content/guides/applications/app-types/index.md b/content/guides/applications/app-types/index.md index b5ccc107f..fdf1f0fb5 100644 --- a/content/guides/applications/app-types/index.md +++ b/content/guides/applications/app-types/index.md @@ -23,7 +23,7 @@ create. | Application Type | Authentication Methods | | ----------------------------- | ------------------------------------------------------------------- | -| [Custom App][custom-apps] | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Grant][ccg] | +| [Platform App][custom-apps] | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Grant][ccg] | | [Limited Access App][laa] | [App Token][apptoken] | | [Custom Skill][custom-skills] | No selection needed | diff --git a/content/guides/applications/app-types/select.md b/content/guides/applications/app-types/select.md index d0d0ed4db..964973c34 100644 --- a/content/guides/applications/app-types/select.md +++ b/content/guides/applications/app-types/select.md @@ -27,7 +27,7 @@ You cannot change this selection later on. | | | | -------------------------- | ---------------------------------------------------------------------------- | | **Authentication methods** | [OAuth 2.0][oauth2], [JWT][jwt], or [Client Credentials Authentication][ccg] | -| **Notable Features** | Webhooks, App Center, and Web App Integrations | +| **Notable Features** | Webhooks, Integrations, and Web App Integrations | Custom App encompasses most use cases and is the most flexible option. This application type allows for interaction with our 150+ endpoints. diff --git a/content/guides/applications/images/my-apps-page.png b/content/guides/applications/images/my-apps-page.png deleted file mode 100644 index 493aedc24..000000000 Binary files a/content/guides/applications/images/my-apps-page.png and /dev/null differ diff --git a/content/guides/applications/index.md b/content/guides/applications/index.md index 4beed1aaf..e5efa1483 100644 --- a/content/guides/applications/index.md +++ b/content/guides/applications/index.md @@ -13,33 +13,31 @@ alias_paths: Box Developer Console allows you to create applications you can then use to integrate with Box. -**My Apps** view displays a list of already created applications +**My Platform Apps** view displays a list of already created applications and gives you quick access to their configuration details. This way, you don't need to open the app each time you want to generate a Developer Token, copy the Client ID, or generate a report. -![My apps](./images/my-apps-page.png) - ## Features -**My Apps** page allows you to: +**My Platform Apps** page allows you to: * Search through the list of already created apps. * Filter the apps by **Enablement Status** and **Authentication Type**. * Create [a new app][select]. * Copy the app's [Client ID][clientcredentials]. * Rename the app and access its details with one click. -* Check application [enablement][enablement] and [authorization][authorization] status. Apps published to App Center display status from App Center. +* Check application [enablement][enablement] and [authorization][authorization] status. Apps published to Integrations display status from Integrations. The **Options menu** available for every entry allows you to: * Access the configuration details of your application. * Generate a [Developer Token][token]. * Add collaborators to your application. -* Run the [App Diagnostics Report][report]. +* Run the [Platform App Diagnostics Report][report]. -## App Insights +## Platform App Insights Admins and co-admins can access the Platform Insights dashboard that provides a comprehensive diff --git a/content/guides/applications/app-center/images/app-center.png b/content/guides/applications/integrations/images/app-center.png similarity index 100% rename from content/guides/applications/app-center/images/app-center.png rename to content/guides/applications/integrations/images/app-center.png diff --git a/content/guides/applications/app-center/images/submit-and-approve.png b/content/guides/applications/integrations/images/submit-and-approve.png similarity index 100% rename from content/guides/applications/app-center/images/submit-and-approve.png rename to content/guides/applications/integrations/images/submit-and-approve.png diff --git a/content/guides/applications/app-center/images/submit-app.png b/content/guides/applications/integrations/images/submit-app.png similarity index 100% rename from content/guides/applications/app-center/images/submit-app.png rename to content/guides/applications/integrations/images/submit-app.png diff --git a/content/guides/applications/app-center/index.md b/content/guides/applications/integrations/index.md similarity index 82% rename from content/guides/applications/app-center/index.md rename to content/guides/applications/integrations/index.md index 842ff7120..d210f3be5 100644 --- a/content/guides/applications/app-center/index.md +++ b/content/guides/applications/integrations/index.md @@ -12,17 +12,17 @@ alias_paths: - /guides/applications/app-gallery/ --- -# App Center +# Integrations -The [Box App Center][app-center] is the first place for Box users to find out +The [Box Integrations][app-center] is the first place for Box users to find out about applications that they can use in combination with Box. If your application is suited to be used by other enterprises, listing your service in -the App Center can be a great way to find new users. -App center groups apps into sections so that you can +the Integrations can be a great way to find new users. +Integrations groups apps into sections so that you can quickly find featured, most popular, or recently added apps. - ![App Center](./images/app-center.png) + ![Integrations](./images/app-center.png) ## Developing and app or becoming a Box Partner @@ -41,20 +41,20 @@ Center][app-center]. Your application must meet the following requirements: * The application is in a finished state and ready for production usage. -* The application leverages OAuth 2.0 authentication, as the App Center does not support any other authentication methods. +* The application leverages OAuth 2.0 authentication, as the Integrations does not support any other authentication methods. * You are a developer with access to the application in the [Developer Console][devconsole]. ### 1. Log in to the Developer Console Navigate to the [Developer Console][devconsole] and select your application to -submit to the App Center. +submit to the Integrations. ### 2. Fill in the form -Select the **App Center** tab from the top menu. +Select the **Integrations** tab from the top menu. - ![App Center panel](./images/app-center.png) + ![Integrations panel](./images/app-center.png) Click the button to "Submit My App". @@ -93,7 +93,7 @@ Approval" button. Once approved and published, an application can be unpublished from the same control panel. Navigate to the [Developer Console][devconsole] and select -your application. Then, select the "App Center" panel from the left-hand +your application. Then, select the "Integrations" panel from the left-hand sidebar. The app can be unpublished from this page. [app-center]: https://app.box.com/services diff --git a/content/guides/applications/web-app-integrations/configure.md b/content/guides/applications/web-app-integrations/configure.md index 34950ebb4..6fe666191 100644 --- a/content/guides/applications/web-app-integrations/configure.md +++ b/content/guides/applications/web-app-integrations/configure.md @@ -4,7 +4,7 @@ related_endpoints: [] related_guides: - authentication/oauth2/oauth2-setup - authentication/tokens - - applications/app-center + - applications/integrations required_guides: [] related_resources: [] alias_paths: [] @@ -47,7 +47,7 @@ To configure the integration, follow the guidance below for each value. | Field | Description | |--------------------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Integration name | The name of your integration, which users see in the Box Web App when they select the **More Options** > **Integrations** menu on a file or folder. | -| Description | The description of the integration displayed in the Box App Center. | +| Description | The description of the integration displayed in the Box Integrations. | | Supported file extensions | The integration will only appear as an option in the **More Options** > **Integrations** menu for the selected file extensions. | | Permissions requirement | Determines what permissions level users need to see the integration. **Download permissions are required** allows users to download the file - they will not be able to update it. **Full permissions are required** allows users to download and update the file. | | Integration scopes | Specifies the scope of your integration - either the file/folder from which integration is invoked, or its parent folder. | @@ -95,8 +95,8 @@ The following parameter values are available. ### Integration Status - **Development**: The integration is visible and available only to application collaborators listed under the **General Settings** tab. This option is best used when the application is still in development and undergoing testing. -- **Online**: The integration is visible and available to all Box users. This option is best used when development is complete and the application is ready to publish in the App Center. -- **Maintenance**: The integration is visible and available only to application collaborators listed under the **General Settings** tab. This option is best used after the integration is published in the App Center, but needs to perform maintenance updates or troubleshoot issues. Use this option to temporarily take the integration offline for everyone except the application's collaborators. +- **Online**: The integration is visible and available to all Box users. This option is best used when development is complete and the application is ready to publish in the Integrations. +- **Maintenance**: The integration is visible and available only to application collaborators listed under the **General Settings** tab. This option is best used after the integration is published in the Integrations, but needs to perform maintenance updates or troubleshoot issues. Use this option to temporarily take the integration offline for everyone except the application's collaborators. ## Example Use Cases of Box Integrations @@ -139,7 +139,7 @@ note that the URL must be publicly accessible on the internet. ## Making Integration Publicly Available To make a Box integration publicly available it needs to be listed in the App -Center. Follow the [App Center][app-center] guide for more details. +Center. Follow the [Integrations][integrations] guide for more details. [ca]: g://applications/app-types/custom-apps [pu]: g://applications/web-app-integrations/types @@ -149,4 +149,4 @@ Center. Follow the [App Center][app-center] guide for more details. [custom-oauth2]: g://authentication/oauth2/oauth2-setup [devconsole]: https://app.box.com/developers/console [devaccount]: https://account.box.com/signup/n/developer -[app-center]: g://applications/app-center +[integrations]: g://applications/integrations diff --git a/content/guides/applications/web-app-integrations/index.md b/content/guides/applications/web-app-integrations/index.md index c57736aee..adc3a72de 100644 --- a/content/guides/applications/web-app-integrations/index.md +++ b/content/guides/applications/web-app-integrations/index.md @@ -34,7 +34,7 @@ restricted to certain content types and file extensions. Learn how to create a Web App Integration -[app-center]: g://applications/app-center +[integrations]: g://applications/integrations [custom-app]: g://authentication/oauth2/oauth2-setup [oauth2]: g://authentication/oauth2 diff --git a/content/guides/applications/web-app-integrations/user-experience.md b/content/guides/applications/web-app-integrations/user-experience.md index d7be76942..2a6e1d6e0 100644 --- a/content/guides/applications/web-app-integrations/user-experience.md +++ b/content/guides/applications/web-app-integrations/user-experience.md @@ -12,9 +12,9 @@ alias_paths: [] The following explains what a Web App Integration looks like from a user's point of view. -1. Box users can discover applications in the Box App Center. They can visit the App Center directly, or select the **Apps** menu from the Box Web App UI. -2. In the App Center they select the application they would like to add. Every published Box application has a public profile page, which provides details including the integrations it provides. -3. They user adds the application to their account by clicking the **Add** button in the App Center listing. Once an application is added to an account, all its integrations become available to the user. +1. Box users can discover applications in the Box Integrations. They can visit the Integrations directly, or select the **Integrations** menu from the Box Web App UI. +2. In the Integrations they select the application they would like to add. Every published Box application has a public profile page, which provides details including the integrations it provides. +3. They user adds the application to their account by clicking the **Add** button in the Integrations listing. Once an application is added to an account, all its integrations become available to the user. 4. Select an integration from the **More Actions** menu on a file or folder. 5. Box will ask the user for permission to share the file or folder with the application. The confirmation prompt must accepted before the integration can be successfully used. 6. Upon granting access, Box passes the data to the application. Depending on the type of integration, the application will then display a popup panel or run a server-based process. \ No newline at end of file diff --git a/content/guides/authentication/app-token/app-token-setup.md b/content/guides/authentication/app-token/app-token-setup.md index de6322c2d..c4b6b5234 100644 --- a/content/guides/authentication/app-token/app-token-setup.md +++ b/content/guides/authentication/app-token/app-token-setup.md @@ -26,7 +26,7 @@ for authentication. ## 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 the [Developer Console][devconsole] from your Box enterprise account. Alternatively, you may sign up for a [developer account][devaccount]. @@ -35,9 +35,9 @@ account. Alternatively, you may sign up for a [developer account][devaccount]. ### 1. Log in to the Developer Console Log into Box and navigate to the [Developer Console][devconsole]. -Select **Create New App**. +Select **Create Platform App**. -### 2. Create a Custom App +### 2. Create a Platform App Select **Limited Access App** from the list of application types. A modal will appear to prompt the next step. diff --git a/content/guides/authentication/client-credentials/client-credentials-setup.md b/content/guides/authentication/client-credentials/client-credentials-setup.md index cc37962c5..54beb71b7 100644 --- a/content/guides/authentication/client-credentials/client-credentials-setup.md +++ b/content/guides/authentication/client-credentials/client-credentials-setup.md @@ -27,7 +27,7 @@ account. Alternatively, you may sign up for a [developer account][devaccount]. ### Navigate to the Developer Console Log into Box and go to the [Developer Console][devconsole]. -Select **Create New App**. +Select **Create Platform App**. ### Select application type diff --git a/content/guides/authentication/jwt/jwt-setup.md b/content/guides/authentication/jwt/jwt-setup.md index 527ae7018..942052674 100644 --- a/content/guides/authentication/jwt/jwt-setup.md +++ b/content/guides/authentication/jwt/jwt-setup.md @@ -18,7 +18,7 @@ alias_paths: # Setup with JWT -A Custom App can be set up to use server-side authentication with +A Platform App can be set up to use server-side authentication with [JWT][jwt]. @@ -27,7 +27,7 @@ A Custom App can be set up to use server-side authentication with ## 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 the [Developer Console][devconsole] from your Box enterprise account. Alternatively, you may sign up for a [developer account][devaccount]. @@ -36,11 +36,11 @@ account. Alternatively, you may sign up for a [developer account][devaccount]. ### Navigate to the Developer Console Log into Box and go to the [Developer Console][devconsole]. -Select **Create New App**. +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. @@ -65,7 +65,7 @@ Use the drop-down list to select the app's purpose. Depending on the option chos ### Select application authentication Select **Server Authentication (with JWT)** if you would like to verify -application identity [with a key pair][kp] and confirm with **Create App**. +application identity [with a key pair][kp] and confirm with **Create Platform App**. Once you make a selection, you will not be able to change to a different @@ -83,7 +83,7 @@ authentication method without creating a new application. (Client Credentials Grant) as your authentication method. -Once a Custom App is created leveraging Server Authentication with JWT, a key +Once a Platform App is created leveraging Server Authentication with JWT, a key pair can be generated via the configuration tab within the [Developer Console][devconsole]. Alternatively, you can generate your own and supply Box with the public key. Regardless of the method you select, @@ -160,7 +160,7 @@ approval. More information on this process is available in our [support article for app authorization][app-auth]. - Learn how to authorize a Custom Application + Learn how to authorize a Platform Application ## Basic configuration diff --git a/content/guides/authentication/oauth2/oauth2-setup.md b/content/guides/authentication/oauth2/oauth2-setup.md index 9b40a7a40..edc50de67 100644 --- a/content/guides/authentication/oauth2/oauth2-setup.md +++ b/content/guides/authentication/oauth2/oauth2-setup.md @@ -32,7 +32,7 @@ account. Alternatively, you may sign up for a [developer account][devaccount]. ### Navigate to the Developer Console Log into Box and go to the -[Developer Console][devconsole]. Select **Create New App**. +[Developer Console][devconsole]. Select **Create Platform App**. ### Select application type diff --git a/content/guides/authentication/tokens/developer-tokens.md b/content/guides/authentication/tokens/developer-tokens.md index 471212658..5b18254ea 100644 --- a/content/guides/authentication/tokens/developer-tokens.md +++ b/content/guides/authentication/tokens/developer-tokens.md @@ -26,8 +26,8 @@ To create a Developer Token for an application: - Under Developer Token, select **Generate Developer Token**. -You can also generate a Developer Token directly from [My Apps][apps] view, -using the menu available for each app. +You can also generate a Developer Token directly from [My Platform Apps][apps] +view, using the menu available for each app. diff --git a/content/guides/authentication/tokens/index.md b/content/guides/authentication/tokens/index.md index ab6bced2c..e3a4ab7f3 100644 --- a/content/guides/authentication/tokens/index.md +++ b/content/guides/authentication/tokens/index.md @@ -16,7 +16,7 @@ with content the user associated with the Access Token either a collaborator on or owns. This can be further restricted by [downscoping][ds] a token. - Application scopes, application access, enabled advanced settings, user + Required access scopes, application access, enabled advanced settings, user permissions, and endpoint-specific restrictions all work together to determine which API calls will be successful. For example, even if a user has collaborator access to a folder, a call to get information about the folder diff --git a/content/guides/authorization/custom-app-approval.md b/content/guides/authorization/custom-app-approval.md index a2d299161..8d3661c1f 100644 --- a/content/guides/authorization/custom-app-approval.md +++ b/content/guides/authorization/custom-app-approval.md @@ -24,7 +24,7 @@ A Box Admin needs an application's Client ID in order to properly authorize or enable it in the Admin Console. -You can use [My Apps][apps] view to quickly look up +You can use [Integrations][apps] view to quickly look up the authorization and enablement status of your application. @@ -67,7 +67,7 @@ application. 2. Scroll down to the OAuth 2.0 Credentials section and copy the **Client ID** value to provide to a Box Admin. Alternatively, hover over the application in the -[My Apps][apps] view to look up the **ClientID** and then +[My Platform Apps][apps] view to look up the **ClientID** and then copy it using the `copy` button. @@ -80,10 +80,10 @@ 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. -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. +1. Navigate to the [Admin Console][adminconsole] and select the **Integrations** tab (1) from the left navigation panel. +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 Platform App** (3) button in the top right corner to add a new app. +4. Alternatively, you can use the Platform Apps Manager table menu (4) to authorize and enable apps. #### Server Authentication Apps diff --git a/content/guides/authorization/index.md b/content/guides/authorization/index.md index 69dc9fecc..ebb772408 100644 --- a/content/guides/authorization/index.md +++ b/content/guides/authorization/index.md @@ -39,10 +39,10 @@ enabled: These [settings][setting] can be found by navigating to: -**Admin Console** > **Apps** > **Custom Apps** > click the ⚙ icon +**Admin Console** > **Apps** > **Platform Apps** > click the ⚙ icon - Published apps are any applications that can be found in our App Center. + Published apps are any applications that can be found in our Integrations. ## Required actions @@ -64,10 +64,10 @@ scenarios. | Authentication Method | Enabled | Disabled | ------------------------------------------------ | ----------------------------------------------------------------------------------- | --------------------------------------- | -|[OAuth 2.0][standauth] | Enable in **Apps** > **Custom Apps Manager** > **User Authentication Apps** > **Add App** | Ready for use | -|[Server Authentication (with JWT)][jwt] | Authorize and enable in **Apps** > **Custom Apps Manager** > **Server Authentication Apps** > **Add App** | Authorize in **Apps** > **Custom Apps Manager** > **Server Authentication Apps** > **Add App** | -|[Server Authentication (client credentials)][cc] | Authorize and enable in **Apps** > **Custom Apps Manager** > **Server Authentication Apps** | Authorize in **Apps** > **Custom Apps Manager** > **Server Authentication Apps** > **Add App** | -|[App Token Authentication][apptoken] | Authorize and enable in **Apps** > **Custom Apps Manager** > **Server Authentication Apps** > **Server Authentication Apps** > **Add App** | Ready for use | +|[OAuth 2.0][standauth] | Enable in **Apps** > **Platform Apps Manager** > **User Authentication Apps** > **Platform App** | Ready for use | +|[Server Authentication (with JWT)][jwt] | Authorize and enable in **Integrations** > **Platform Apps Manager** > **Server Authentication Apps** > **Add Platform App** | Authorize in **Integrations** > **Platform Apps Manager** > **Server Authentication Apps** > **Add Platform App** | +|[Server Authentication (client credentials)][cc] | Authorize and enable in **Apps** > **Platform Apps Manager** > **Server Authentication Apps** | Authorize in **Integrations** > **Platform Apps Manager** > **Server Authentication Apps** > **Add Platform App** | +|[App Token Authentication][apptoken] | Authorize and enable in **Integrations** > **Platform Apps Manager** > **Server Authentication Apps** > **Server Authentication Apps** > **Add Platform App** | Ready for use | **Require manual admin authorization for transactional access apps**: @@ -76,7 +76,7 @@ scenarios. |[OAuth 2.0][standauth] | N/A | N/A | |[Server Authentication (with JWT)][jwt] | N/A | N/A | |[Server Authentication (client credentials)][cc] | N/A | N/A | -|[App Token Authentication][apptoken] | Authorize in **Apps** > **Custom Apps Manager** > **Server Authentication Apps** | Automatically authorized and enabled upon creation | +|[App Token Authentication][apptoken] | Authorize in **Integrations** > **Platform Apps Manager** > **Server Authentication Apps** | Automatically authorized and enabled upon creation | @@ -86,7 +86,7 @@ scenarios. [sa]: page://platform/user-types/#service-account [scopes]: g://api-calls/permissions-and-errors/scopes -[ag]: g://applications/app-center +[ag]: g://applications/integrations [standauth]: g://authentication/oauth2 [jwt]: g://authentication/jwt [cc]: g://authentication/client-credentials diff --git a/content/guides/authorization/limited-access-approval.md b/content/guides/authorization/limited-access-approval.md index 190a721ab..7bf3bdb8f 100644 --- a/content/guides/authorization/limited-access-approval.md +++ b/content/guides/authorization/limited-access-approval.md @@ -13,7 +13,7 @@ alias_paths: [] # Limited Access App Approval -Limited Access Apps are automatically authorized for use in an enterprise upon +Limited Access Integrations are automatically authorized for use in an enterprise upon creation. However, if the enterprise setting to @@ -58,8 +58,8 @@ section and copy the Client ID value to provide to a Box Admin. ### As an Admin As a Box Admin, navigate to the [Admin Console][adminconsole] and -select the **Apps** tab (1) from the left navigation panel. Then, click the -**Custom Apps** tab (2) at the top of your screen. On this screen, you will +select the **Integrations** tab (1) from the left navigation panel. Then, click the +**Platform Apps** tab (2) at the top of your screen. On this screen, you will see a **+** button in the top right corner to add a new app authorization. diff --git a/content/guides/authorization/platform-app-approval.md b/content/guides/authorization/platform-app-approval.md new file mode 100644 index 000000000..0546cfd4c --- /dev/null +++ b/content/guides/authorization/platform-app-approval.md @@ -0,0 +1,133 @@ +--- +rank: 1 +related_endpoints: [] +related_guides: +- authorization/limited-access-approval +- authorization/custom-skill-approval +required_guides: +- authorization +- authentication/oauth2/oauth2-setup +- authentication/jwt/jwt-setup +alias_paths: +- /guides/applications/custom-apps/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. + +Unpublished applications using [OAuth 2.0][oauth] authentication may +require enablement by a Box Admin if they are [inactive by default][upa]. + +A Box Admin needs an application's Client ID in order to properly +authorize or enable it in the Admin Console. + + +You can use [My Platform Apps][apps] view to quickly look up +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. + +### Server authentication apps + +Navigate to the **Authorization** tab for your application in the +[Developer Console][devconsole]. + + + ![Authorization tab](images/app_authorization.png) + + +### User authentication apps + +Navigate to the **Enablement** tab for your application in the [Developer Console][devconsole]. + + + ![Enablement tab](images/app_enablement.png) + + +Submitting the application for approval will send an email to your +enterprise's Primary Admin to approve the application. +When a Box Admin approves or declines your request, +you will get an email with the decision. +More information on this process is available in our [support article on app authorization][app-auth]. + +## Manual Approval + +The following steps provide instructions on how to manually approve the +application. + +### As a developer + +1. Navigate to the **Configuration** tab for your application in the [Developer Console][devconsole]. +2. Scroll down to the OAuth 2.0 Credentials section and copy the **Client ID** value to provide to a Box Admin. + +Alternatively, hover over the application in the +[My Platform Apps][apps] view to look up the **ClientID** and then +copy it using the `copy` button. + + + # Finding a Box Admin + + If you don't know your enterprise Admin, go to your Box [Account + Settings][settings] page and scroll to the bottom. If an admin contact is set + you should see their contact information under "Admin Contact". + + +### 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. +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. + +#### Server Authentication Apps + + + ![Server Apps tab](images/jwt_app_approval_flow.png) + + +#### User Authentication Apps + + + ![User Apps tab](images/oauth_app_approval_flow.png) + + +In the popup that appears, enter the client ID for the application that the +developer collected from the **Configuration** tab of the +[Developer Console][devconsole]. + +## Re-authorization on changes + +When the application's scopes or access level change the application needs to be +re-authorized. Repeat the process above and request a new Access Token for the +new changes to take effect. + +In the same section where the application was initially authorized, an Admin +can re-authorize the application by clicking on the ellipses to the right +of the application name to **Reauthorize App**. + + + ![Re-authorize app](images/reauthorize_app.png) + + + +[devconsole]: https://app.box.com/developers/console + +[ccg]: g://authentication/client-credentials + +[settings]: https://app.box.com/account +[adminconsole]: https://app.box.com/master/settings/custom + +[jwt]: g://authentication/jwt +[app-token]: g://authentication/app-token +[oauth]: g://authentication/oauth2 +[upa]: g://security/#enterprise-settings-and-authorization + +[app-auth]: https://support.box.com/hc/en-us/articles/360043697014-Authorizing-Apps-in-the-Box-App-Approval-Process + +[apps]: g://applications \ No newline at end of file diff --git a/content/guides/box-ai/ai-tutorials/prerequisites.md b/content/guides/box-ai/ai-tutorials/prerequisites.md index 9a99d6eff..13605b633 100644 --- a/content/guides/box-ai/ai-tutorials/prerequisites.md +++ b/content/guides/box-ai/ai-tutorials/prerequisites.md @@ -48,7 +48,7 @@ settings, contact your admin. To add a scope: 1. Open your application in Developer Console. -2. Go to **Configuration** > **Application Scopes** > **Content Actions** +2. Go to **Configuration** > **Required Access Scopes** > **Content Actions** 3. Select the **Manage AI** scope. Box Platform will automatically include the scope when making the call. If you are added as an collaborator for a given app, but do not have Box AI API access, you will see the **Manage AI** scope checked and grayed out. This means the app owner has the AI scope enabled but you cannot change this setting. ![box ai scopes](../images/box-ai-app-scopes.png) @@ -62,7 +62,7 @@ to authenticate your app when sending requests. To generate a token: -1. Go to **Developer Console** > **My Apps**. +1. Go to **Developer Console** > **My Platform Apps**. 2. Click the **Options menu** button (…) on the right. 3. Select **Generate Developer Token**. The token will be automatically generated and saved to clipboard. diff --git a/content/guides/cli/cli-docs/jwt-cli.md b/content/guides/cli/cli-docs/jwt-cli.md index 1252a1733..dc93ecba4 100644 --- a/content/guides/cli/cli-docs/jwt-cli.md +++ b/content/guides/cli/cli-docs/jwt-cli.md @@ -36,7 +36,7 @@ following scopes are set in the **Configuration** tab of your application: 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 New App** > **Custom App** > **Server Authentication (with JWT)** > name the application > **Create App** +2. Click **Create Platform App** > **Platform App** > **Server Authentication (with JWT)** > name the application > **Create App** Server Authentication (with JWT) always requires Admin authorization before use. diff --git a/content/guides/collaborations/connect-slack-to-group-collabs/1-configure-slack.md b/content/guides/collaborations/connect-slack-to-group-collabs/1-configure-slack.md index 94b4be5a0..97c5b1b58 100644 --- a/content/guides/collaborations/connect-slack-to-group-collabs/1-configure-slack.md +++ b/content/guides/collaborations/connect-slack-to-group-collabs/1-configure-slack.md @@ -18,7 +18,7 @@ This section will take you through the following steps. ## Create a minimal Slack app -Go to the **[Slack apps page][slack-apps]** and click **Create New App**. Add +Go to the **[Slack apps page][slack-apps]** and click **Create Platform App**. Add an **App Name**, select your **Development Slack Workspace** from the dropdown list where the bot will be deployed to, then click **Create App**. diff --git a/content/guides/getting-started/first-application.md b/content/guides/getting-started/first-application.md index 681d8ac26..1373c1902 100644 --- a/content/guides/getting-started/first-application.md +++ b/content/guides/getting-started/first-application.md @@ -41,7 +41,7 @@ Begin with the most basic settings. Open the **General Settings** tab and check or fill in below fields: - **App Name** - the name you set up during the app creation, you can change it here if needed; -- **Contact Email** - this is set to the developer of the application by default. Keep in mind that once you publish your app, this email is publicly visible to Box users who view your app in the [App Center][app-center]. We recommend to change it to a support email address, so that users can reach out to support in case of any issues with the integration; +- **Contact Email** - this is set to the developer of the application by default. Keep in mind that once you publish your app, this email is publicly visible to Box users who view your app in the [Integrations][app-center]. We recommend to change it to a support email address, so that users can reach out to support in case of any issues with the integration; - **Collaborators** - add other developers that can work on this integration, so that they can access the developer interface in case they need to adjust any settings. @@ -60,7 +60,7 @@ features, and add CORS domains. In the next tabs you can create webhooks, web app integrations, submit app for enablement for access to the Enterprise, submit your app -to the [Box App Center][app-center], and generate a report to view this application’s +to the [Box Integrations][integrations], and generate a report to view this application’s activity. ## Test your app @@ -84,7 +84,7 @@ You can also use [Box CLI tool][box-cli] if you prefer to use the terminal. [console]: https://cloud.app.box.com/developers/console [auth]: g://authentication/select [oauth2]: g://authentication/oauth2 -[app-center]: g://applications/app-center +[integrations]: g://applications/integrations [add-users]: https://support.box.com/hc/en-us/articles/360043694594-Add-Users [app-center]: https://cloud.app.box.com/app-center [dev-token]: g://authentication/tokens/developer-tokens/#create-developer-token diff --git a/content/guides/getting-started/publish-app.md b/content/guides/getting-started/publish-app.md index 925806f07..90ee3ae59 100644 --- a/content/guides/getting-started/publish-app.md +++ b/content/guides/getting-started/publish-app.md @@ -5,7 +5,7 @@ rank: 3 # Publish your application When you finish the app configuration and testing, you can publish -it in the [Box App Center][app-center]. It allows customers to find +it in the [Box Integrations][app-center]. It allows customers to find your application and add it to their Box accounts. @@ -13,7 +13,7 @@ your application and add it to their Box accounts. Only applications that use the OAuth 2.0 authentication have a built-in publication option. You can use other user authentication types, but such app can only serve as a marketing listing in the -App Center and redirect customers to your website. +Integrations and redirect customers to your website. @@ -21,12 +21,12 @@ To publish your app: 1. Open the **Dev Console**. 2. Select the application you want to publish. -3. Go to the **App Center** tab and submit your app. +3. Go to the **Integrations** tab and submit your app. This action gives you access to the marketing section of the application, where you need to add the following app information: -- **General App Info** - choose correct categories and platforms for your application to make it easier to find in the App Center, +- **General App Info** - choose correct categories and platforms for your application to make it easier to find in the Integrations, - **App Description** - make sure it contains all information about your application that the customers may find useful, - **Short Description** appears next to your app logo, together with your app name; - **Long Description** is what the users see after they select your app to view its details. You can add clickable links to the long description. @@ -40,7 +40,7 @@ Console. When you're finished with providing the details about your app, submit your app for approval. Box will review your application -and publish it in the App Center. +and publish it in the Integrations. In case of any questions or issues, contact the Partners team: integrate@box.com diff --git a/content/guides/integration-mappings/slack-mappings/setup.md b/content/guides/integration-mappings/slack-mappings/setup.md index 3b5a2a9b9..3ee2b09f4 100644 --- a/content/guides/integration-mappings/slack-mappings/setup.md +++ b/content/guides/integration-mappings/slack-mappings/setup.md @@ -34,7 +34,7 @@ If you encounter any errors, see the [troubleshooting guide][3]. ## Create Box application 1. Create a [custom app with OAuth authentication][4] in the [Box developer console][5] -2. Open the application and enable the **Manage enterprise properties** application scope under **Configuration** > **Application Scopes**. +2. Open the application and enable the **Manage enterprise properties** application scope under **Configuration** > **Required Access Scopes**. For Slack-side channel validation, the [Integration Mappings API][6] diff --git a/content/guides/mobile/ios/quick-start/3-configure-box-app.md b/content/guides/mobile/ios/quick-start/3-configure-box-app.md index 825ad26c6..2e36d313d 100644 --- a/content/guides/mobile/ios/quick-start/3-configure-box-app.md +++ b/content/guides/mobile/ios/quick-start/3-configure-box-app.md @@ -3,11 +3,11 @@ type: quick-start hide_in_page_nav: true --- -# Configure a Box App +# Configure a Box Platform App To start making authenticated API calls to the Box API with the **Box iOS SDK**, an **Access Token** will be needed. The simplest way to generate a valid -token is to generate a new **Box App** and manually generate a short lived +token is to generate a new **Box Platform App** and manually generate a short lived developer token. The developer token is generated through the developer console UI and will be @@ -38,12 +38,12 @@ valid for one hour before having to be manually refreshed. token, use the following steps. 1. Go to the [Developer Console][devconsole] - 2. Select **Create New App** - 3. Select **Custom App** as the type of application to create, and click **Next** + 2. Select **Create Platform App** + 3. Select **Platform App** as the type of application to create, and click **Next** 4. Select **OAuth 2.0 with JWT** as the authentication method, and click **Next** - 5. Give your Box app a unique name and click **Create App** - 6. Go to the app's configuration by clicking **View Your App**. - 7. Optionally, scroll to the **Application Scopes** section of the same screen and select any additional permissions you want to enable for this application. + 5. Give your Box app a unique name and click **Create Platform App** + 6. Go to the app's configuration by clicking **View Your Platform App**. + 7. Optionally, scroll to the **Required Access Scopes** section of the same screen and select any additional permissions you want to enable for this application. 8. At the top of the page click the button to **Save Changes** diff --git a/content/guides/security/index.md b/content/guides/security/index.md index f69c9b254..7593e3c91 100644 --- a/content/guides/security/index.md +++ b/content/guides/security/index.md @@ -140,7 +140,7 @@ There are a few enterprise settings to be aware of when it comes to the Box API. Custom applications fall into two categories: published and unpublished. -Published applications are found in the [Box App Center][appcenter]. Box +Published applications are found in the [Box Integrations][appcenter]. Box Admins decide whether published and unpublished application are enabled by default and therefore can be used without approval. The status of these settings determines what actions are necessary to successfully [authorize][auth] an diff --git a/content/guides/skills/handle/setup.md b/content/guides/skills/handle/setup.md index 41a7f3c46..328ef1dae 100644 --- a/content/guides/skills/handle/setup.md +++ b/content/guides/skills/handle/setup.md @@ -15,7 +15,7 @@ Setting up a Custom Skill is a multi-step process. ## 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]. @@ -39,7 +39,7 @@ will appear to prompt the next step. ### 3. Provide a name -Finally, select a unique name for your application and click **Create App**. +Finally, select a unique name for your application and click **Create Platform App**. diff --git a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md index caf7fa805..583b59548 100644 --- a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md +++ b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/3-configure-box.md @@ -33,12 +33,12 @@ create users that are associated with the Okta user account. the following steps. 1. Go to the [Developer Console][devconsole] - 2. Select **Create New App** - 3. Select **Custom App** as the type of application to create, and click **Next** + 2. Select **Create Platform App** + 3. Select **Platform App** as the type of application to create, and click **Next** 4. Select **OAuth 2.0 with JWT** as the authentication method, and click **Next** 5. Give your Box app a unique name and click **Create App** 6. Go to the app's configuration by clicking **View Your App**. - 7. Scroll to the **Application Scopes** section of the same screen and ensure that at least the following scopes are enabled: + 7. Scroll to the **Required Access Scopes** section of the same screen and ensure that at least the following scopes are enabled: * Read and write all files and folders stored in Box * Manage Users 8. Under **Advanced Features** ensure that both options are enabled to perform actions as users and generate user access tokens. diff --git a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md index 98e354ec2..aa58d5207 100644 --- a/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md +++ b/content/guides/sso-identities-and-app-users/connect-okta-to-app-users/5-find-or-create-box-users.md @@ -15,7 +15,7 @@ This section will cover the final Box components: * Creating a new app user for the associated Okta record if they don't. * Fetching tokens for the Box user to make user-specific API calls. -## Create New App Users +## Create Platform App Users Before validating users we need a method for creating an associated Box user account if one doesn't already exist for the Okta user. diff --git a/content/guides/webhooks/v1/create-v1.md b/content/guides/webhooks/v1/create-v1.md index d7eebcc2a..10f5a5d07 100644 --- a/content/guides/webhooks/v1/create-v1.md +++ b/content/guides/webhooks/v1/create-v1.md @@ -44,7 +44,7 @@ to begin use. To obtain the URL to add the app, follow the directions below for OAuth 2.0 authentication apps: -1. Navigate to the **App Center** tab for the application in the [Developer Console][devconsole]. +1. Navigate to the **Integrations** tab for the application in the [Developer Console][devconsole]. 2. Click **Submit My App**. Do not worry, you will not be completing the submission process! 3. At the bottom of the page, click **Preview**. 4. Click **Add** diff --git a/content/guides/webhooks/v2/create-v2.md b/content/guides/webhooks/v2/create-v2.md index 767046af6..5a6847325 100644 --- a/content/guides/webhooks/v2/create-v2.md +++ b/content/guides/webhooks/v2/create-v2.md @@ -24,7 +24,7 @@ created in the [Developer Console][console] and with API. V2 webhooks can be created only when the scope **Manage Webhooks** is selected and the application is authorized. See more about - [application scopes][1] and [authorization][2]. + [Required Access Scopes][1] and [authorization][2]. To create a webhook follow the steps below. diff --git a/content/microcopy/headers.yml b/content/microcopy/headers.yml index cebdbbfba..71a19e924 100644 --- a/content/microcopy/headers.yml +++ b/content/microcopy/headers.yml @@ -120,7 +120,7 @@ primary: console: // text: The text for the link to the developer console - text: My Apps + text: My Platform Apps // url: The URL to the developer console url: https://cloud.app.box.com/developers/console diff --git a/content/pages/platform/application-types.md b/content/pages/platform/application-types.md index ec9599798..98a8a9ec4 100644 --- a/content/pages/platform/application-types.md +++ b/content/pages/platform/application-types.md @@ -18,7 +18,7 @@ provides customizable UI Elements for tasks like browsing, searching, and previewing content. These apps support OAuth 2.0, JWT, and Client Credentials Grant for authentication. Custom Apps are ideal for applications that need to access both their own and others' files, upload and download files, and -potentially be listed in the Box App Center. +potentially be listed in the Box Integrations. ## Limited Access App @@ -51,17 +51,17 @@ add new features to Box users and be added to Recommended Apps in Box Preview, enhancing the user experience by integrating with various content types and file extensions. -## App Center Publication +## Integrations Publication -The [Box App Center][app_center] is a platform for Box users to discover +The [Box Integrations][integrations] is a platform for Box users to discover applications that can be used in conjunction with Box. For developers, listing their application -in the App Center is an effective way to reach new users, particularly for -applications suited for use by other enterprises. The process for App Center +in the Integrations is an effective way to reach new users, particularly for +applications suited for use by other enterprises. The process for Integrations publication involves ensuring the app is production-ready, leverages OAuth 2.0 authentication, and submitting it for approval through the Developer Console. Once approved, applications can be featured, most popular, or recently added -sections in the App Center, and they can also be unpublished if necessary. +sections in the Integrations, and they can also be unpublished if necessary. Next step @@ -71,4 +71,4 @@ sections in the App Center, and they can also be unpublished if necessary. [limited_app]: g://applications/app-types/limited-access-apps/ [skills]: g://applications/app-types/custom-skills/ [web_app]: g://applications/web-app-integrations/ -[app_center]: g://applications/app-center/ \ No newline at end of file +[integrations]: g://applications/integrations/ \ No newline at end of file diff --git a/content/pages/platform/box-glossary.md b/content/pages/platform/box-glossary.md index c36b046e6..4f318266b 100644 --- a/content/pages/platform/box-glossary.md +++ b/content/pages/platform/box-glossary.md @@ -17,7 +17,7 @@ to find out what a term means, this is your one stop page. | Anonymous User | | A user that is not logged in. | | App user | | Box [app user][app user] is a specific type of user within the Box Platform who is associated with applications or services that integrate with Box. App users are only accessible with the API, meaning they do not have login credentials. They can be created by a service account and are only applicable to applications leveraging server to server authentication. App users are tied to the application used to create them, and the user itself cannot be moved under another application. They can however collaborate on content outside of the application. | | Bookmark / web link | Symbolic link, Symlink, soft link, reference, relationship | A clickable reference that allows you to easily access external websites or specific locations within your content structure. | -| Box App Center | App Store | The first place for Box users to find out about applications that they can use in combination with Box. | +| Box Integrations | App Store | The first place for Box users to find out about applications that they can use in combination with Box. | | Box Command Line Interface | [Box CLI][CLI] | A user-friendly command line tool that allows both technical and non-technical users to leverage the Box API to perform routine or bulk actions. | | Box Custom Skill | Custom Skill, Box Skill | An application that performs custom processing for files uploaded to Box. Skills are designed to make it possible to use third-party machine learning services to automatically extract information from files uploaded to Box. | | [Box Embed][embed] | | An HTML-based framework that makes it possible to embed the Box Web App experience anywhere in the 3rd party applications. Box Embed provides the ability to upload, search, comment, share, tag, and edit files using Box Edit. | diff --git a/content/pages/platform/box-platform-101.md b/content/pages/platform/box-platform-101.md index a7b244d25..ab0f94dc4 100644 --- a/content/pages/platform/box-platform-101.md +++ b/content/pages/platform/box-platform-101.md @@ -97,8 +97,8 @@ web app, they should be able to access it using the API. ### Application Type There are three main types of applications that can be created in the developer -console. They include custom app, limited access app, and custom skills. You can -also create third party and web app integrations. +console. They include platform app, limited access app, and custom skills. You +can also create third party and web app integrations. ![Application Types](images/app_type.png)