Collection categories

Usage service handles licensing

List all Collection categories

Retrieve a list of collection categories

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

The page number for pagination

pageSize
integer
Default: 20

The number of items per page

object
Responses
200

OK response.

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

Create a new Collection category

Create a new collection category

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

The name of the root organizational unit

workspaceId
integer

The ID of the workspace

name
string

The name of the new category

description
string

A description of the category

is_predefined
boolean

Whether the category is predefined

enabled
boolean

Whether the category is enabled

Responses
200

OK response.

post/v1/org/categories
Request samples
application/json
{
  • "rootOuName": "string",
  • "workspaceId": 0,
  • "name": "string",
  • "description": "string",
  • "is_predefined": true,
  • "enabled": true
}
Response samples
application/json
{
  • "id": "9fe62fc3-31aa-4cf0-a62f-677eaeff33b2",
  • "name": "Finance",
  • "description": "This is the second team c",
  • "is_predefined": false,
  • "enabled": true
}

Delete Collection categories in bulk

Delete multiple collection categories in a single request

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

OK response.

delete/v1/org/categories
Request samples
application/json
[
  • "string"
]
Response samples
application/json
{
  • "records": [
    ],
  • "count": 2
}

Update an existing Collection category

Update an existing collection category

Securityx-api-key
Request
path Parameters
id
required
string

The unique identifier of the collection category to be updated

Request Body schema: application/json
name
string

The updated name of the category

description
string

The updated description of the category

is_predefined
boolean

Whether the category is predefined

enabled
boolean

Whether the category is enabled

Responses
200

OK response.

put/v1/org/categories/{id}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_predefined": true,
  • "enabled": true
}
Response samples
application/json
{
  • "id": "cb147922-a0c2-4563-b3fe-f1e67aa7eb4c",
  • "name": "Testing Team",
  • "description": "This is an updated description for the collection category",
  • "is_predefined": true,
  • "enabled": true
}

Delete a single Collection category

Delete an existing collection category

Securityx-api-key
Request
path Parameters
id
required
string

The unique identifier of the collection category to be deleted

Responses
200

OK response.

delete/v1/org/categories/{id}
Request samples
curl -X DELETE 'https://app.harness.io/gratis/sei/api/v1/org/categories/{id}' \
-H 'Content-Type: application/json' \
-H 'Authorization: <See API Usage>'
Response samples
application/json
{
  • "records": [
    ],
  • "count": 1
}