diff --git a/openapi.json b/openapi.json index af264a98..913a9a2a 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": "e3e3e24e9f" + "x-box-commit-hash": "8f64ba5ffc" }, "servers": [ { diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json index 2c9eaf46..5097a5d5 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": "e3e3e24e9f" + "x-box-commit-hash": "8f64ba5ffc" }, "servers": [ { @@ -912,6 +912,242 @@ "Box Doc Gen" ] } + }, + "/shield_lists": { + "get": { + "operationId": "get_shield_lists_v2025.0", + "summary": "Get all shield lists in enterprise", + "description": "Retrieves all shield lists in the enterprise.", + "parameters": [ + { + "$ref": "#/components/parameters/BoxVersionHeader" + } + ], + "responses": { + "200": { + "description": "Returns the list of shield list objects.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShieldLists" + } + } + } + } + }, + "x-box-tag": "shield_lists", + "tags": [ + "Shield lists" + ] + }, + "post": { + "operationId": "post_shield_lists_v2025.0", + "summary": "Create shield list", + "description": "Creates a shield list.", + "parameters": [ + { + "$ref": "#/components/parameters/BoxVersionHeader" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShieldListsCreate" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the shield list object.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShieldList" + } + } + } + }, + "409": { + "description": "The shield list with this name already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientError" + } + } + } + } + }, + "x-box-tag": "shield_lists", + "tags": [ + "Shield lists" + ] + } + }, + "/shield_lists/{shield_list_id}": { + "get": { + "operationId": "get_shield_lists_id_v2025.0", + "summary": "Get single shield list by shield list id", + "description": "Retrieves a single shield list by its ID.", + "parameters": [ + { + "$ref": "#/components/parameters/BoxVersionHeader" + }, + { + "name": "shield_list_id", + "in": "path", + "description": "The unique identifier that represents a shield list.\nThe ID for any Shield List can be determined by the response from the endpoint\nfetching all shield lists for the enterprise.", + "required": true, + "schema": { + "type": "string" + }, + "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 " + } + ], + "responses": { + "200": { + "description": "Returns the shield list object.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShieldList" + } + } + } + }, + "404": { + "description": "The shield list was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientError" + } + } + } + } + }, + "x-box-tag": "shield_lists", + "tags": [ + "Shield lists" + ] + }, + "delete": { + "operationId": "delete_shield_lists_id_v2025.0", + "summary": "Delete single shield list by shield list id", + "description": "Delete a single shield list by its ID.", + "parameters": [ + { + "$ref": "#/components/parameters/BoxVersionHeader" + }, + { + "name": "shield_list_id", + "in": "path", + "description": "The unique identifier that represents a shield list.\nThe ID for any Shield List can be determined by the response from the endpoint\nfetching all shield lists for the enterprise.", + "required": true, + "schema": { + "type": "string" + }, + "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 " + } + ], + "responses": { + "204": { + "description": "Shield List correctly removed. No content in response." + }, + "400": { + "description": "The shield list is assigned to some rules and cannot be removed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientError" + } + } + } + }, + "404": { + "description": "The shield list was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientError" + } + } + } + } + }, + "x-box-tag": "shield_lists", + "tags": [ + "Shield lists" + ] + }, + "put": { + "operationId": "put_shield_lists_id_v2025.0", + "summary": "Update shield list", + "description": "Updates a shield list.", + "parameters": [ + { + "$ref": "#/components/parameters/BoxVersionHeader" + }, + { + "name": "shield_list_id", + "in": "path", + "description": "The unique identifier that represents a shield list.\nThe ID for any Shield List can be determined by the response from the endpoint\nfetching all shield lists for the enterprise.", + "required": true, + "schema": { + "type": "string" + }, + "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 " + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShieldListsUpdate" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the shield list object.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ShieldList" + } + } + } + }, + "404": { + "description": "The shield list was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientError" + } + } + } + }, + "409": { + "description": "The shield list with this name already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClientError" + } + } + } + } + }, + "x-box-tag": "shield_lists", + "tags": [ + "Shield lists" + ] + } } }, "components": { @@ -1761,6 +1997,421 @@ ], "title": "File version (Base)" }, + "ShieldList": { + "description": "A standard representation of a Shield List.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the shield list.", + "type": "string", + "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24" + }, + "type": { + "description": "Type of the object.", + "type": "string", + "example": "shield_list" + }, + "name": { + "description": "Name of the shield list.", + "type": "string", + "example": "Shield List Name" + }, + "enterprise": { + "allOf": [ + { + "$ref": "#/components/schemas/EnterpriseReference" + }, + { + "description": "Enterprise for which this list belongs to." + } + ] + }, + "description": { + "description": "Description of Shield List", + "type": "string", + "example": "A list of things that are shielded" + }, + "created_at": { + "description": "ISO date time string when this shield list object was created.", + "type": "string", + "format": "date-time", + "example": "2025-01-13T15:31:01.896Z" + }, + "updated_at": { + "description": "ISO date time string when this shield list object was updated.", + "type": "string", + "format": "date-time", + "example": "2025-01-13T15:31:01.896Z" + }, + "content": { + "allOf": [ + { + "$ref": "#/components/schemas/ShieldListContent" + }, + { + "description": "Specifies the type of elements in this Shield List and includes the elements themselves." + } + ] + } + }, + "required": [ + "id", + "type", + "name", + "content", + "enterprise", + "created_at", + "updated_at" + ], + "title": "Shield List", + "x-box-resource-id": "shield_list_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldList--Mini": { + "description": "A mini representation of a Shield List.", + "type": "object", + "properties": { + "id": { + "description": "Unique global identifier for this list", + "type": "string", + "example": "12345678-1234-1234-1234-123456789012" + }, + "type": { + "description": "The type of object", + "type": "string", + "example": "shield_list", + "enum": [ + "shield_list" + ] + }, + "name": { + "description": "Name of Shield List", + "type": "string", + "example": "My Shield List" + }, + "content": { + "properties": { + "type": { + "description": "The type of content in the shield list.", + "type": "string", + "example": "country_code" + } + }, + "type": "object" + } + }, + "required": [ + "id", + "type", + "name", + "content" + ], + "title": "Shield List (Mini)", + "x-box-resource-id": "shield_list_v2025.0--mini", + "x-box-tag": "shield_lists" + }, + "ShieldListContent": { + "description": "Representation of content of a Shield List", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ShieldListContentCountry" + }, + { + "$ref": "#/components/schemas/ShieldListContentDomain" + }, + { + "$ref": "#/components/schemas/ShieldListContentEmail" + }, + { + "$ref": "#/components/schemas/ShieldListContentIp" + }, + { + "$ref": "#/components/schemas/ShieldListContentIntegration" + } + ], + "title": "Shield List Content" + }, + "ShieldListContentCountry": { + "description": "Representation of content of a Shield List that contains countries data.", + "type": "object", + "properties": { + "type": { + "description": "The type of content in the shield list.", + "type": "string", + "example": "country", + "enum": [ + "country" + ] + }, + "country_codes": { + "description": "List of country codes values.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "US", + "PL" + ], + "maximum": 1000, + "minimum": 1, + "uniqueItems": true + } + }, + "required": [ + "type", + "country_codes" + ], + "title": "Shield List Content (Country)", + "x-box-resource-id": "shield_list_content__country_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldListContentDomain": { + "description": "Representation of content of a Shield List that contains domains data.", + "type": "object", + "properties": { + "type": { + "description": "The type of content in the shield list.", + "type": "string", + "example": "domain", + "enum": [ + "domain" + ] + }, + "domains": { + "description": "List of domain.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "box.com", + "example.com" + ], + "maximum": 100000, + "minimum": 1, + "uniqueItems": true + } + }, + "required": [ + "type", + "domains" + ], + "title": "Shield List Content (Domain)", + "x-box-resource-id": "shield_list_content__domains_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldListContentEmail": { + "description": "Representation of content of a Shield List that contains email addresses data.", + "type": "object", + "properties": { + "type": { + "description": "The type of content in the shield list.", + "type": "string", + "example": "email", + "enum": [ + "email" + ] + }, + "email_addresses": { + "description": "List of emails", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "example1@box.com", + "example2@gmail.com" + ], + "maximum": 100000, + "minimum": 1, + "uniqueItems": true + } + }, + "required": [ + "type", + "email_addresses" + ], + "title": "Shield List Content (Email)", + "x-box-resource-id": "shield_list_content__email_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldListContentIntegration": { + "description": "Representation of content of a Shield List that contains integrations data.", + "type": "object", + "properties": { + "type": { + "description": "The type of content in the shield list.", + "type": "string", + "example": "integration", + "enum": [ + "integration" + ] + }, + "integrations": { + "description": "List of integration", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "The ID of the integration.", + "type": "string", + "example": "505e40b5-5d04-446a-9268-72a0ccc13669" + } + } + }, + "minimum": 1, + "uniqueItems": true + } + }, + "required": [ + "type", + "integrations" + ], + "title": "Shield List Content (Integration)", + "x-box-resource-id": "shield_list_content__integration_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldListContentIp": { + "description": "Representation of content of a Shield List that contains ip addresses data.", + "type": "object", + "properties": { + "type": { + "description": "The type of content in the shield list.", + "type": "string", + "example": "ip", + "enum": [ + "ip" + ] + }, + "ip_addresses": { + "description": "List of ips and cidrs.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "127.0.0.1", + "80.12.12.12/24" + ], + "maximum": 100000, + "minimum": 1, + "uniqueItems": true + } + }, + "required": [ + "type", + "ip_addresses" + ], + "title": "Shield List Content (IP)", + "x-box-resource-id": "shield_list_content__ip_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldListContentRequest": { + "description": "Representation of content of a Shield List", + "type": "object", + "oneOf": [ + { + "$ref": "#/components/schemas/ShieldListContentCountry" + }, + { + "$ref": "#/components/schemas/ShieldListContentDomain" + }, + { + "$ref": "#/components/schemas/ShieldListContentEmail" + }, + { + "$ref": "#/components/schemas/ShieldListContentIp" + } + ], + "title": "Shield List Content for requests" + }, + "ShieldLists": { + "description": "List of Shield List objects", + "type": "object", + "allOf": [ + { + "properties": { + "entries": { + "description": "A list of shield list objects", + "type": "array", + "items": { + "$ref": "#/components/schemas/ShieldList--Mini" + } + } + } + } + ], + "title": "List of Shield Lists", + "x-box-resource-id": "shield_lists_v2025.0", + "x-box-tag": "shield_lists" + }, + "ShieldListsCreate": { + "description": "The schema for Shield List create request.", + "type": "object", + "properties": { + "name": { + "description": "The name of the shield list.", + "type": "string", + "example": "My Shield List" + }, + "description": { + "description": "Description of Shield List: Optional.", + "type": "string", + "example": "A list of things that are shielded" + }, + "content": { + "allOf": [ + { + "$ref": "#/components/schemas/ShieldListContentRequest" + }, + { + "description": "Specifies the type of elements in this Shield List and includes the elements themselves.\nIt is not possible to update Integration Shield Lists by Public API." + } + ] + } + }, + "required": [ + "name", + "content" + ], + "title": "Create Shield List create request", + "x-box-tag": "shield_lists" + }, + "ShieldListsUpdate": { + "description": "The schema for Shield List update request.", + "type": "object", + "properties": { + "name": { + "description": "The name of the shield list.", + "type": "string", + "example": "My Shield List" + }, + "description": { + "description": "Description of Shield List: Optional.", + "type": "string", + "example": "A list of things that are shielded" + }, + "content": { + "allOf": [ + { + "$ref": "#/components/schemas/ShieldListContentRequest" + }, + { + "description": "Specifies the type of elements in this Shield List and includes the elements themselves.\nIt is not possible to update Integration Shield Lists by Public API." + } + ] + } + }, + "required": [ + "name", + "content" + ], + "title": "Create Shield List update request", + "x-box-tag": "shield_lists" + }, "User--Base": { "description": "A mini representation of a user, used when\nnested within another resource.", "type": "object", @@ -1825,6 +2476,11 @@ "name": "Box Doc Gen templates", "description": "Doc Gen templates are used as input to generate documents.", "x-box-tag": "docgen_template" + }, + { + "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.", + "x-box-tag": "shield_lists" } ], "externalDocs": { diff --git a/openapi/openapi.json b/openapi/openapi.json index af264a98..913a9a2a 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": "e3e3e24e9f" + "x-box-commit-hash": "8f64ba5ffc" }, "servers": [ {