Collections

Usage service handles licensing

Retrieve a list of collections

This API endpoint allows you to retrieve a list of collections. The endpoint is paginated.

Securityx-api-key
Request
Request Body schema: application/json
page
integer
Default: 0

The page number for pagination

page_size
integer

The number of items per page (default may vary)

object
Responses
200

OK response.

post/v1/org/units/list
Request samples
application/json
{
  • "page": 0,
  • "page_size": 0,
  • "filter": {
    }
}
Response samples
application/json
{
  • "records": [
    ],
  • "count": 2,
  • "_metadata": {
    }
}

Create a new collection

This API endpoint allows you to create a new collection.

Securityx-api-key
Request
Request Body schema: application/json
Array
name
string

The name of the new collection

ou_category_id
string

The ID of the category to which the collection belongs

parent_ref_id
string

The reference ID of the parent collection

Array of objects
Responses
200

OK response.

post/v1/org/units
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "errors": [ ],
  • "success": [
    ]
}

Edit an existing collection

This API endpoint allows you to edit an existing collection.

Securityx-api-key
Request
Request Body schema: application/json
Array
id
string

The reference ID of the collection to be edited

name
string or null

The new name for the collection

ou_category_id
string or null

The ID of the category to which the collection belongs

parent_ref_id
string or null

The reference ID of the parent collection

Array of objects
Responses
200

OK response.

put/v1/org/units
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "errors": [ ],
  • "success": [
    ]
}

Delete an existing collection

This API endpoint allows you to delete an existing collection.

Securityx-api-key
Request
Request Body schema: application/json
Array
string

The reference ID of the collection to be deleted. Multiple IDs can be included in the array to delete multiple collections in a single request.

Responses
200

OK response.

delete/v1/org/units
Request samples
application/json
[
  • "string"
]
Response samples
application/json
{
  • "message": "The collection(s) were successfully deleted."
}