diff --git a/openapi.json b/openapi.json index bd00fda6..c934edae 100644 --- a/openapi.json +++ b/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "04730436d5" + "x-box-commit-hash": "e231c9d1b8" }, "servers": [ { diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 40cb980c..ff549750 100644 --- a/openapi/openapi-v2025.0.json +++ b/openapi/openapi-v2025.0.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", - "x-box-commit-hash": "04730436d5" + "x-box-commit-hash": "e231c9d1b8" }, "servers": [ { @@ -2479,6 +2479,64 @@ "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": { @@ -3356,6 +3414,68 @@ }, "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", @@ -4436,7 +4556,7 @@ ] }, "ip_addresses": { - "description": "List of ips and cidrs.", + "description": "List of ip addresses and CIDRs.", "type": "array", "items": { "type": "string" @@ -4636,8 +4756,32 @@ ], "title": "User (Mini)" }, + "UserReference": { + "description": "User reference.", + "type": "object", + "properties": { + "type": { + "description": "The value is always `user`.", + "type": "string", + "example": "user", + "enum": [ + "user" + ] + }, + "id": { + "description": "The unique identifier for the user.", + "type": "string", + "example": "12345" + } + }, + "required": [ + "type", + "id" + ], + "title": "User reference" + }, "WeblinkReference": { - "description": "Weblink reference.", + "description": "Web link reference.", "type": "object", "properties": { "type": { @@ -4650,7 +4794,7 @@ "nullable": false }, "id": { - "description": "ID of the weblink.", + "description": "ID of the web link.", "type": "string", "example": "42037322", "nullable": false @@ -4660,7 +4804,7 @@ "type", "id" ], - "title": "Weblink reference" + "title": "Web link reference" } }, "securitySchemes": { @@ -4707,6 +4851,11 @@ "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.", @@ -4724,7 +4873,7 @@ }, { "name": "Shield lists", - "description": "Shield List allow an administrator to create a list \nwhich will be shared between different\nShield Smart Access and Threat Prection rules.", + "description": "Shield List allow an administrator to create a list\nwhich will be shared between different\nShield Smart Access and Threat Detection rules.", "x-box-tag": "shield_lists" } ], diff --git a/openapi/openapi.json b/openapi/openapi.json index bd00fda6..c934edae 100644 --- a/openapi/openapi.json +++ b/openapi/openapi.json @@ -14,7 +14,7 @@ "url": "http://www.apache.org/licenses/LICENSE-2.0" }, "version": "2024.0", - "x-box-commit-hash": "04730436d5" + "x-box-commit-hash": "e231c9d1b8" }, "servers": [ {