Skip to content

docs: (DDOC-1687) OTP for public shared links #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ianfre25 merged 1 commit into from
Oct 26, 2026
+8,192 −1,210
Merged

docs: (DDOC-1687) OTP for public shared links #622

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 36 additions & 29 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "53bdced3cd"
"x-box-commit-hash": "da48f6b132"
},
"servers": [
{
Expand Down Expand Up @@ -15251,7 +15251,7 @@
}
},
"400": {
"description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `invalid_parameter` when a parameter is formatted incorrectly,\n for example when the `notification_email` has an incorrectly formatted\n email address.",
"description": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `invalid_parameter` when a parameter is formatted incorrectly,\n for example when the `notification_email` has an incorrectly formatted\n email address.\n* `user_must_not_have_retained_content` when rolling the user out of the enterprise is blocked\n because they own content and the enterprise has a retention policy or legal hold. Transfer the user's content to\n another user first. For the steps for resolution, see\n [User cannot be deleted due to retention policies](https://support.box.com/hc/en-us/articles/33282413279635-API-Content-User-cannot-be-deleted-due-to-retention-policies-Please-transfer-user-content-first).",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -16308,7 +16308,7 @@
}
},
"400": {
"description": "Returns an error if some of the parameters are\nnot valid.\n\n* `Groups can not be NULL or EMPTY` when no value is provided.\n* `group id format is string` when the provided group id format\nis incorrect.\n* `Supported payload format is JSON` when the provided payload\nformat is incorrect.",
"description": "Returns an error if some of the parameters are\nnot valid.\n\n* `Groups can not be NULL or EMPTY` when no value is provided.\n* `group id format is string` when the provided group id format\nis incorrect.\n* `Supported payload format is JSON` when the provided payload\nformat is incorrect.\n* `Too many users included for this request` when more than 10,000 unique users exist across all specified groups.",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -17930,14 +17930,18 @@
"RENAME",
"RETENTION_POLICY_ASSIGNMENT_ADD",
"SHARE",
"SHARED_LINK_ONE_TIME_PASSCODE_ACCESS",
"SHARED_LINK_ONE_TIME_PASSCODE_CHALLENGE",
"SHARED_LINK_SEND",
"SHARE_EXPIRATION",
"SHIELD_ALERT",
"SHIELD_DOWNLOAD_BLOCKED",
"SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED",
"SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION",
"SHIELD_EXTERNAL_COLLAB_ACCESS_JUSTIFIED",
"SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED",
"SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION",
"SHIELD_EXTERNAL_COLLAB_INVITE_JUSTIFIED",
"SHIELD_JUSTIFICATION_APPROVAL",
"SHIELD_PREVIEW_BLOCKED",
"SHIELD_SHARED_LINK_ACCESS_BLOCKED",
Expand Down Expand Up @@ -31088,6 +31092,8 @@
"RENAME",
"RETENTION_POLICY_ASSIGNMENT_ADD",
"SHARE",
"SHARED_LINK_ONE_TIME_PASSCODE_ACCESS",
"SHARED_LINK_ONE_TIME_PASSCODE_CHALLENGE",
"SHARED_LINK_REDIRECT_OUT_OF_SHARED_CONTEXT",
"SHARED_LINK_SEND",
"SHARE_EXPIRATION",
Expand All @@ -31098,6 +31104,7 @@
"SHIELD_DOWNLOAD_BLOCKED",
"SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED",
"SHIELD_EXTERNAL_COLLAB_ACCESS_BLOCKED_MISSING_JUSTIFICATION",
"SHIELD_EXTERNAL_COLLAB_ACCESS_JUSTIFIED",
"SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED",
"SHIELD_EXTERNAL_COLLAB_INVITE_BLOCKED_MISSING_JUSTIFICATION",
"SHIELD_EXTERNAL_COLLAB_INVITE_JUSTIFIED",
Expand Down Expand Up @@ -44936,6 +44943,11 @@
"description": "Box Sign requests are used\nto submit a file for\nsignature.",
"x-box-tag": "sign_requests"
},
{
"name": "Box Sign templates",
"description": "Sign templates allow you to use a predefined Box Sign\ntemplate when creating a signature request.\nThe template includes placeholders that\nare automatically populated with data when creating the request.",
"x-box-tag": "sign_templates"
},
{
"name": "Classifications",
"description": "Classification labels are\nused for content that is\nsensitive or under security\nrestrictions.",
Expand Down Expand Up @@ -45036,11 +45048,6 @@
"description": "Folders, together with Files,\nare at the core of the Box API.\nFolders can be uploaded and downloaded,\nas well as hold important metadata\ninformation about the content.",
"x-box-tag": "folders"
},
{
"name": "Integration mappings",
"description": "Integration Mappings allow the users\nto manage where content from partner apps is stored in Box.",
"x-box-tag": "integration_mappings"
},
{
"name": "Group memberships",
"description": "Group memberships signify that\na user is a part of the group.",
Expand All @@ -45051,6 +45058,11 @@
"description": "Groups created in an enterprise.",
"x-box-tag": "groups"
},
{
"name": "Integration mappings",
"description": "Integration Mappings allow the users\nto manage where content from partner apps is stored in Box.",
"x-box-tag": "integration_mappings"
},
{
"name": "Invites",
"description": "Invites are used to invite the user to\nan enterprise.",
Expand Down Expand Up @@ -45116,6 +45128,11 @@
"description": "Session termination API is used to\nvalidate the roles and permissions of the group,\nand creates asynchronous jobs to terminate the group's sessions.",
"x-box-tag": "session_termination"
},
{
"name": "Shared links (App Items)",
"description": "URLs generated for app items stored in Box,\nwhich provide direct, read-only access to the resource.",
"x-box-tag": "shared_links_app_items"
},
{
"name": "Shared links (Files)",
"description": "Files shared links are URLs that are generated for files stored in Box,\nwhich provide direct, read-only access to the resource.",
Expand All @@ -45132,39 +45149,29 @@
"x-box-tag": "shared_links_web_links"
},
{
"name": "Shared links (App Items)",
"description": "URLs generated for app items stored in Box,\nwhich provide direct, read-only access to the resource.",
"x-box-tag": "shared_links_app_items"
},
{
"name": "Shield information barriers",
"description": "Shield information barrier in Box defines an ethical wall.\nAn ethical wall is a mechanism that prevents exchanges or communication that\ncould lead to conflicts of interest and therefore result in\nbusiness activities ethically or legally questionable.",
"x-box-tag": "shield_information_barriers"
},
{
"name": "Shield information barrier segments",
"description": "Shield information barrier segment represents\na defined group of users. A user can be a member\nof only one segment, which makes segments\ndifferent from groups.",
"x-box-tag": "shield_information_barrier_segments"
"name": "Shield information barrier reports",
"description": "Shield information barrier reports\ncontain information on what existing collaborations\nwill be removed permanently when the information barrier is enabled.",
"x-box-tag": "shield_information_barrier_reports"
},
{
"name": "Shield information barrier segment members",
"description": "Shield information barrier segment member\nrepresents a user that is assigned to a\nspecific segment.",
"x-box-tag": "shield_information_barrier_segment_members"
},
{
"name": "Shield information barrier reports",
"description": "Shield information barrier reports\ncontain information on what existing collaborations\nwill be removed permanently when the information barrier is enabled.",
"x-box-tag": "shield_information_barrier_reports"
},
{
"name": "Shield information barrier segment restrictions",
"description": "Shield information barrier segment restriction is\nan access restriction based on the content (file or folder) owner.",
"x-box-tag": "shield_information_barrier_segment_restrictions"
},
{
"name": "Box Sign templates",
"description": "Sign templates allow you to use a predefined Box Sign\ntemplate when creating a signature request.\nThe template includes placeholders that\nare automatically populated with data when creating the request.",
"x-box-tag": "sign_templates"
"name": "Shield information barrier segments",
"description": "Shield information barrier segment represents\na defined group of users. A user can be a member\nof only one segment, which makes segments\ndifferent from groups.",
"x-box-tag": "shield_information_barrier_segments"
},
{
"name": "Shield information barriers",
"description": "Shield information barrier in Box defines an ethical wall.\nAn ethical wall is a mechanism that prevents exchanges or communication that\ncould lead to conflicts of interest and therefore result in\nbusiness activities ethically or legally questionable.",
"x-box-tag": "shield_information_barriers"
},
{
"name": "Skills",
Expand Down
41 changes: 23 additions & 18 deletions openapi/openapi-v2025.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "https://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "53bdced3cd"
"x-box-commit-hash": "da48f6b132"
},
"servers": [
{
Expand Down Expand Up @@ -994,7 +994,10 @@
}
}
},
"x-box-tag": "enterprise_configurations"
"x-box-tag": "enterprise_configurations",
"tags": [
"Enterprise Configurations"
]
}
},
"/hubs": {
Expand Down Expand Up @@ -3123,7 +3126,9 @@
"id",
"type",
"name",
"size"
"size",
"description",
"owned_by"
],
"title": "Archive",
"x-box-resource-id": "archive_v2025.0",
Expand Down Expand Up @@ -7576,11 +7581,6 @@
"description": "A set of endpoints used to manage archives.",
"x-box-tag": "archives"
},
{
"name": "Enterprise Configurations",
"description": "Enterprise configurations admins interact with to drive Box product behavior.",
"x-box-tag": "enterprise_configurations"
},
{
"name": "Box Doc Gen",
"description": "Doc Gen is used to automatically generate documents.",
Expand All @@ -7591,16 +7591,6 @@
"description": "Doc Gen templates are used as input to generate documents.",
"x-box-tag": "docgen_template"
},
{
"name": "External Users",
"description": "External users are collaborators from outside of your enterprise.",
"x-box-tag": "external_users"
},
{
"name": "Box Hubs",
"description": "A set of endpoints used to manage Box Hubs.",
"x-box-tag": "hubs"
},
{
"name": "Box Hub Collaborations",
"description": "A set of endpoints used to manage collaborations within a Box Hub.",
Expand All @@ -7616,6 +7606,21 @@
"description": "A set of endpoints used to manage items within a Box Hub.",
"x-box-tag": "hub_items"
},
{
"name": "Box Hubs",
"description": "A set of endpoints used to manage Box Hubs.",
"x-box-tag": "hubs"
},
{
"name": "Enterprise Configurations",
"description": "Enterprise configurations admins interact with to drive Box product behavior.",
"x-box-tag": "enterprise_configurations"
},
{
"name": "External Users",
"description": "External users are collaborators from outside of your enterprise.",
"x-box-tag": "external_users"
},
{
"name": "Shield lists",
"description": "Shield List allow an administrator to create a list\nwhich will be shared between different\nShield Smart Access and Threat Detection rules.",
Expand Down
Loading
Loading