Skip to content

Reference

Box

Set up Box OAuth for enterprise file storage and collaboration

Connect your users to Box for enterprise file storage, collaboration, and content management.

PropertyValue
Provider IDbox
CategoryStorage
PKCENot supported
Token refreshAutomatic
Redirect URIShown in Developer Portal

Go to the Box Developer Console

Navigate to app.box.com/developers/console and sign in.

Create a new app

Click Create New App then Custom App. Select User Authentication (OAuth 2.0).

Add the redirect URI

Under Configuration, add the Redirect URI from the Developer Portal to the Redirect URIs field.

Get credentials

Copy the Client ID and Client Secret.

Open the Developer Portal

Go to portal.alterauth.com and navigate to the application.

Add Box provider

Go to OAuth Providers > Add Provider > Box.

Enter credentials

  • Client ID: Paste your Box Client ID
  • Client Secret: Paste your Box Client Secret

Select scopes

Choose the scopes the application needs.

Save

Click Save. The provider is now active.

ScopeDescription
root_readwriteRead and write access to all files and folders
root_readonlyRead-only access to all files and folders
manage_managed_usersManage enterprise users
manage_groupsManage enterprise groups
  • Box scopes are configured at the application level in the Box Developer Console.
  • See the Box OAuth documentation for more details.

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation IDFamiliesMethodProvider path
post_commentssendPOST/comments
post_invitesadmin, sendPOST/invites
post_users_id_email_aliasesadmin, sendPOST/users/{user_id}/email_aliases
put_comments_idsendPUT/comments/{comment_id}
put_users_id_folders_0admin, paymentPUT/users/{user_id}/folders/0
delete_ai_agents_iddeleteDELETE/ai_agents/{agent_id}
delete_collaboration_whitelist_entries_iddeleteDELETE/collaboration_whitelist_entries/{collaboration_whitelist_entry_id}
delete_collaboration_whitelist_exempt_targets_idadmin, deleteDELETE/collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}
delete_collaborations_iddeleteDELETE/collaborations/{collaboration_id}
delete_comments_iddeleteDELETE/comments/{comment_id}
delete_device_pinners_iddeleteDELETE/device_pinners/{device_pinner_id}
delete_file_requests_iddeleteDELETE/file_requests/{file_request_id}
delete_files_iddeleteDELETE/files/{file_id}
delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWodeleteDELETE/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
delete_files_id_metadata_global_boxSkillsCardsdeleteDELETE/files/{file_id}/metadata/global/boxSkillsCards
delete_files_id_metadata_id_idadmin, deleteDELETE/files/{file_id}/metadata/{scope}/{template_key}
delete_files_id_trashdeleteDELETE/files/{file_id}/trash
delete_files_id_versions_iddeleteDELETE/files/{file_id}/versions/{file_version_id}
delete_files_id_watermarkdeleteDELETE/files/{file_id}/watermark
delete_files_upload_sessions_iddeleteDELETE/files/upload_sessions/{upload_session_id}
delete_folder_locks_iddeleteDELETE/folder_locks/{folder_lock_id}
post_files_id_metadata_id_idadmin, writePOST/files/{file_id}/metadata/{scope}/{template_key}
post_folders_id_metadata_id_idadmin, writePOST/folders/{folder_id}/metadata/{scope}/{template_key}
post_metadata_taxonomies_id_id_levelsadmin, writePOST/metadata_taxonomies/{namespace}/{taxonomy_key}/levels
post_metadata_taxonomies_id_id_nodesadmin, writePOST/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes
put_files_id_metadata_id_idadmin, writePUT/files/{file_id}/metadata/{scope}/{template_key}
post_file_requests_id_copywritePOST/file_requests/{file_request_id}/copy
post_files_idwritePOST/files/{file_id}
post_files_id_contentwritePOST/files/{file_id}/content
post_files_id_copywritePOST/files/{file_id}/copy
post_files_id_metadata_enterprise_securityClassification-6VMVochwUWowritePOST/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
post_files_id_metadata_global_boxSkillsCardswritePOST/files/{file_id}/metadata/global/boxSkillsCards
post_files_id_upload_sessionswritePOST/files/{file_id}/upload_sessions
post_files_id_versions_currentwritePOST/files/{file_id}/versions/current
get_comments_idreadGET/comments/{comment_id}
get_file_requests_idreadGET/file_requests/{file_request_id}
get_file_version_legal_holds_idreadGET/file_version_legal_holds/{file_version_legal_hold_id}
get_file_version_retentions_idreadGET/file_version_retentions/{file_version_retention_id}
get_files_idreadGET/files/{file_id}
get_files_id_app_item_associationsreadGET/files/{file_id}/app_item_associations

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.