diff --git a/content/guides/ai-studio/getting-started-ai-studio.md b/content/guides/ai-studio/getting-started-ai-studio.md index c1f9b0f4e..9084354f8 100644 --- a/content/guides/ai-studio/getting-started-ai-studio.md +++ b/content/guides/ai-studio/getting-started-ai-studio.md @@ -80,4 +80,4 @@ calls. [createapps]: g://applications/app-types/platform-apps [postman]: g://tooling/postman [authorization]: g://authorization -[reauthorization]: g://authorization/custom-app-approval#re-authorization-on-changes +[reauthorization]: g://authorization/platform-app-approval#re-authorization-on-changes diff --git a/content/guides/applications/app-types/platform-apps.md b/content/guides/applications/app-types/platform-apps.md index ec36e6b59..746c5297d 100644 --- a/content/guides/applications/app-types/platform-apps.md +++ b/content/guides/applications/app-types/platform-apps.md @@ -61,7 +61,7 @@ Example use cases for a Platform App include: Platform Apps may require approval before use. - + Learn how to approve Platform Apps diff --git a/content/guides/applications/index.md b/content/guides/applications/index.md index e5efa1483..da79a325d 100644 --- a/content/guides/applications/index.md +++ b/content/guides/applications/index.md @@ -61,7 +61,7 @@ and view Platform Insights: [token]: g://authentication/tokens/developer-tokens [authorization]: g://authorization -[enablement]: g://authorization/custom-app-approval#user-authentication-apps +[enablement]: g://authorization/platform-app-approval#user-authentication-apps [select]: g://applications/app-types/select [report]: g://api-calls/permissions-and-errors/app-diagnostics-report [clientcredentials]: g://authentication/client-credentials diff --git a/content/guides/authentication/app-token/app-token-setup.md b/content/guides/authentication/app-token/app-token-setup.md index f81db8861..92822b143 100644 --- a/content/guides/authentication/app-token/app-token-setup.md +++ b/content/guides/authentication/app-token/app-token-setup.md @@ -6,7 +6,7 @@ related_endpoints: [] related_guides: - authentication/select - authentication/oauth2 - - authorization/custom-app-approval + - authorization/platform-app-approval required_guides: - authentication/select - applications/app-types/platform-apps diff --git a/content/guides/authentication/client-credentials/client-credentials-setup.md b/content/guides/authentication/client-credentials/client-credentials-setup.md index ff7a8034b..7911a27fd 100644 --- a/content/guides/authentication/client-credentials/client-credentials-setup.md +++ b/content/guides/authentication/client-credentials/client-credentials-setup.md @@ -87,7 +87,7 @@ Click **Review and Submit** to send an email to your Box enterprise Admin for approval. More information on this process is available in our [authorization guide][app-auth]. - + Learn how to authorize a Platform Application diff --git a/content/guides/authentication/client-credentials/index.md b/content/guides/authentication/client-credentials/index.md index ff82d2ac7..1f7e87010 100644 --- a/content/guides/authentication/client-credentials/index.md +++ b/content/guides/authentication/client-credentials/index.md @@ -109,4 +109,4 @@ Once you make changes to the app settings, don't forget to [reauthorize][reauth] [sa]: page://platform/user-types/#service-account [auth]: g://authorization [aa]: g://authentication/client-credentials/client-credentials-setup/#application-access -[reauth]: g://authorization/custom-app-approval#re-authorization-on-changes +[reauth]: g://authorization/platform-app-approval#re-authorization-on-changes diff --git a/content/guides/authentication/jwt/jwt-setup.md b/content/guides/authentication/jwt/jwt-setup.md index 7935eb518..57f9e6366 100644 --- a/content/guides/authentication/jwt/jwt-setup.md +++ b/content/guides/authentication/jwt/jwt-setup.md @@ -6,7 +6,7 @@ related_guides: required_guides: - authentication/select - applications/app-types/platform-apps - - authorization/custom-app-approval + - authorization/platform-app-approval related_resources: [] alias_paths: - /docs/setting-up-a-jwt-app @@ -159,7 +159,7 @@ Click **Review and Submit** to send an email to your Box enterprise Admin for approval. More information on this process is available in our [support article for app authorization][app-auth]. - + Learn how to authorize a Platform Application diff --git a/content/guides/authentication/sso.md b/content/guides/authentication/sso.md index b39684d1e..660083c1a 100644 --- a/content/guides/authentication/sso.md +++ b/content/guides/authentication/sso.md @@ -21,7 +21,7 @@ being built. ## Platform Apps with Client-side Authentication -When users authenticate with a [Platform App][custom_app] configured to use +When users authenticate with a [Platform App][platform_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. @@ -49,7 +49,7 @@ having a Box account matching the email address passed via SAML. ## Platform Apps with Server-side Authentication -For [Platform Apps][custom_app] that use [JWT][jwt] or +For [Platform Apps][platform_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. @@ -83,12 +83,12 @@ therefore SSO is not involved. [mu]: page://platform/user-types/#managed-users -[admin-approval]: g://authorization/custom-app-approval +[admin-approval]: g://authorization/platform-app-approval [jwt]: g://authentication/jwt [oauth2]: g://authentication/oauth2 [ccg]: g:///authentication/client-credentials [la-app]: guide://applications/web-app-integrations [app_token]: g://authentication/app-token -[custom_app]: g://applications/app-types/platform-apps +[platform_app]: g://applications/app-types/platform-apps [custom_skills]: g://applications/app-types/custom-skills [jwt]: g://authentication/jwt/jwt-setup diff --git a/content/guides/authorization/custom-app-approval.md b/content/guides/authorization/custom-app-approval.md deleted file mode 100644 index 9281ebc21..000000000 --- a/content/guides/authorization/custom-app-approval.md +++ /dev/null @@ -1,133 +0,0 @@ ---- -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 [Integrations][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 platform 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 **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 - - - ![Server tab](images/oauth_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/authorization/custom-skill-approval.md b/content/guides/authorization/custom-skill-approval.md index 4b3a58a3f..7d3f40531 100644 --- a/content/guides/authorization/custom-skill-approval.md +++ b/content/guides/authorization/custom-skill-approval.md @@ -3,7 +3,7 @@ rank: 4 related_endpoints: - post_files_id_metadata_global_boxSkillsCards related_guides: -- authorization/custom-app-approval +- authorization/platform-app-approval - authorization/limited-access-approval required_guides: - authorization diff --git a/content/guides/authorization/index.md b/content/guides/authorization/index.md index ffef58da2..580d6a23b 100644 --- a/content/guides/authorization/index.md +++ b/content/guides/authorization/index.md @@ -1,7 +1,7 @@ --- rank: 25 required_guides: -- authorization/custom-app-approval +- authorization/platform-app-approval - authorization/limited-access-approval - authorization/custom-skill-approval --- diff --git a/content/guides/authorization/limited-access-approval.md b/content/guides/authorization/limited-access-approval.md index fc9f6327b..f18a46627 100644 --- a/content/guides/authorization/limited-access-approval.md +++ b/content/guides/authorization/limited-access-approval.md @@ -2,7 +2,7 @@ rank: 2 related_endpoints: [] related_guides: -- authorization/custom-app-approval +- authorization/platform-app-approval - authorization/custom-skill-approval required_guides: - authorization diff --git a/content/guides/box-ai/ai-tutorials/prerequisites.md b/content/guides/box-ai/ai-tutorials/prerequisites.md index d5e7a957e..4db0773a2 100644 --- a/content/guides/box-ai/ai-tutorials/prerequisites.md +++ b/content/guides/box-ai/ai-tutorials/prerequisites.md @@ -86,4 +86,4 @@ calls. [postman]: g://tooling/postman [form]: https://forms.gle/Nsh3TwM3W8qg4U35A [authorization]: g://authorization -[reauthorization]: g://authorization/custom-app-approval#re-authorization-on-changes +[reauthorization]: g://authorization/platform-app-approval#re-authorization-on-changes diff --git a/content/guides/cli/cli-docs/jwt-cli.md b/content/guides/cli/cli-docs/jwt-cli.md index 25c8ccde0..2359837aa 100644 --- a/content/guides/cli/cli-docs/jwt-cli.md +++ b/content/guides/cli/cli-docs/jwt-cli.md @@ -205,7 +205,7 @@ Notification Email: [] [keypair]: g://authentication/jwt/jwt-setup/#public-and-private-key-pair [sa]: page://platform/user-types/#service-account [scopes]: g://api-calls/permissions-and-errors/scopes -[ag]: g://authorization/custom-app-approval +[ag]: g://authorization/platform-app-approval [blogpost]: https://medium.com/box-developer-blog/box-api-understanding-security-9fcad7b1d72e diff --git a/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md b/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md index 96bb71584..8e0efc699 100644 --- a/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md +++ b/content/guides/collaborations/connect-slack-to-group-collabs/2-configure-box.md @@ -48,7 +48,7 @@ collaborators to files and folders in Box. Once the application is created it will still need to be approved by an enterprise admin before you will be able to make calls to the Box APIs. - Follow [this guide](g://authorization/custom-app-approval) to have the + Follow [this guide](g://authorization/platform-app-approval) to have the application approved in your enterprise. @@ -76,7 +76,7 @@ collaborators to files and folders in Box. enterprise admin before you will be able to make calls to any of the Box APIs that need any of the new permissions. - Follow [this guide](g://authorization/custom-app-approval) to have the + Follow [this guide](g://authorization/platform-app-approval) to have the application approved in your enterprise. diff --git a/content/guides/embed/box-view/setup.md b/content/guides/embed/box-view/setup.md index 073e8cfc8..2595da6cb 100644 --- a/content/guides/embed/box-view/setup.md +++ b/content/guides/embed/box-view/setup.md @@ -30,7 +30,7 @@ to begin making API requests to Box. App Token apps need to be authorized by the Box admin, otherwise you will receive permission errors when making API requests. To go through app - authorization, follow [this guide](guide://authorization/custom-app-approval). + authorization, follow [this guide](guide://authorization/platform-app-approval). ## Generate Access Token diff --git a/content/guides/embed/ui-elements/open-with.md b/content/guides/embed/ui-elements/open-with.md index ccd07c797..cf3aa2b5d 100644 --- a/content/guides/embed/ui-elements/open-with.md +++ b/content/guides/embed/ui-elements/open-with.md @@ -39,7 +39,7 @@ either through NPM or the Box CDN. ## Box Edit -Box Edit requires additional setup in order to be integrated into a custom +Box Edit requires additional setup in order to be integrated into a platform application. Box Edit uses the desktop application [Box Tools][tools] in order to open content locally. @@ -76,7 +76,7 @@ to your application in the developer console. Once your application has been activated for API calls it will need to be reauthorized in your enterprise. The steps for performing these actions are -available [here](g://authorization/custom-app-approval). +available [here](g://authorization/platform-app-approval). ## List available integrations diff --git a/content/guides/security/index.md b/content/guides/security/index.md index 81b514d89..49c250e23 100644 --- a/content/guides/security/index.md +++ b/content/guides/security/index.md @@ -193,7 +193,7 @@ require enablement. [serviceaccount]: page://platform/user-types/#service-account [appusers]: page://platform/user-types/#app-user [mu]: page://platform/user-types/#managed-users -[auth]: g://authorization/custom-app-approval +[auth]: g://authorization/platform-app-approval [oauth]: g://authentication/oauth2 [jwt]: g://authentication/jwt [ccg]: g://authentication/client-credentials 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 96f20c631..6720b4204 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 @@ -49,7 +49,7 @@ create users that are associated with the Okta user account. enterprise admin before you will be able to make calls to the Box APIs. - Follow [this guide](g://authorization/custom-app-approval) to have the + Follow [this guide](g://authorization/platform-app-approval) to have the application approved in your enterprise. diff --git a/content/pages/platform/user-types.md b/content/pages/platform/user-types.md index ce4bcd768..87f98fc09 100644 --- a/content/pages/platform/user-types.md +++ b/content/pages/platform/user-types.md @@ -295,7 +295,7 @@ would need to turn on this switch. [dc]: https://app.box.com/developers/console -[auth]: g://authorization/custom-app-approval +[auth]: g://authorization/platform-app-approval [scopes]: g://api-calls/permissions-and-errors/scopes [collabapi]: e://post-collaborations [getuser]: e://get-users-me