Skip to content

docs: revert External User Deletion API updates #544

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
wsocha merged 1 commit into from
Aug 7, 2025
Merged

docs: revert External User Deletion API updates #544

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
2 changes: 1 addition & 1 deletion openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "831cbf66ff"
"x-box-commit-hash": "54fd82a523"
},
"servers": [
{
Expand Down
127 changes: 1 addition & 126 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": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2025.0",
"x-box-commit-hash": "831cbf66ff"
"x-box-commit-hash": "54fd82a523"
},
"servers": [
{
Expand Down Expand Up @@ -2479,64 +2479,6 @@
"Archives"
]
}
},
"/external_users/submit_delete_job": {
"post": {
"operationId": "post_external_users_submit_delete_job_v2025.0",
"summary": "Submit job to delete external users",
"description": "Delete external users from current user enterprise. This will remove each\nexternal user from all invited collaborations within the current enterprise.",
"parameters": [
{
"$ref": "#/components/parameters/BoxVersionHeader"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalUsersSubmitDeleteJobRequest"
}
}
}
},
"responses": {
"207": {
"description": "Multi-status response containing the result for each external user deletion request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExternalUsersSubmitDeleteJobResponse"
}
}
}
},
"404": {
"description": "Returns an error if the listed external users are not found, or the authenticated\nuser does not have the right permissions to delete external users.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
},
"default": {
"description": "An unexpected client error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientError"
}
}
}
}
},
"x-box-tag": "external_users",
"tags": [
"External Users"
]
}
}
},
"components": {
Expand Down Expand Up @@ -3414,68 +3356,6 @@
},
"title": "Enterprise reference"
},
"ExternalUserDeletionResult": {
"description": "Result of a single external user deletion request.",
"type": "object",
"properties": {
"user_id": {
"description": "The ID of the external user.",
"type": "string",
"example": "12345"
},
"status": {
"description": "HTTP status code for a specific user's deletion request.",
"type": "integer",
"example": 202
},
"detail": {
"description": "Deletion request status details.",
"type": "string",
"example": "Successfully submitted for deletion"
}
},
"required": [
"user_id",
"status"
],
"title": "External User Deletion Result"
},
"ExternalUsersSubmitDeleteJobRequest": {
"description": "Request to submit a job to delete external users from the current enterprise.",
"type": "object",
"properties": {
"external_users": {
"description": "List of external users to delete.",
"type": "array",
"items": {
"$ref": "#/components/schemas/UserReference"
}
}
},
"required": [
"external_users"
],
"title": "External Users Submit Delete Job Request"
},
"ExternalUsersSubmitDeleteJobResponse": {
"description": "Multi-status response containing the result for each external user deletion request.",
"type": "object",
"properties": {
"entries": {
"description": "Array of results of each external user deletion request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ExternalUserDeletionResult"
}
}
},
"required": [
"entries"
],
"title": "External Users Submit Delete Job Response",
"x-box-resource-id": "external_users_submit_delete_job_response_v2025.0",
"x-box-tag": "external_users"
},
"FileReference": {
"description": "File reference.",
"type": "object",
Expand Down Expand Up @@ -4874,11 +4754,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": "Hubs",
"description": "A set of endpoints used to manage Hubs.",
Expand Down
2 changes: 1 addition & 1 deletion openapi/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"version": "2024.0",
"x-box-commit-hash": "831cbf66ff"
"x-box-commit-hash": "54fd82a523"
},
"servers": [
{
Expand Down