Collection categories

This contains APIs specific to the Collection categories

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

Payload
curl
Java
Go

application/json

{"page": 0,
"pageSize": 20,
"filter": {"name": ["string"
],
"is_predefined": true,
"enabled": true
}
}

Response samples

application/json

{"records": [{"id": "6cad073a-b7bf-4606-b706-302f19d8e133",
"name": "Organizing",
"description": "This is the first team c",
"is_predefined": true,
"enabled": true,
"count_of_ous": 1,
"created_at": 1654841196842,
"updated_at": 1654841196842
},
{"id": "9fe62fc3-31aa-4cf0-a62f-677eaeff33b2",
"name": "Finance",
"description": "This is the second team c",
"enabled": true,
"count_of_ous": 0,
"is_predefined": false,
"created_at": 1654841375866,
"updated_at": 1654841375866
},
{"id": "75504d25-4980-4952-a282-ab6933fdff8b",
"name": "Dev Team",
"description": "This is the thrid team c",
"enabled": true,
"count_of_ous": 1,
"is_predefined": true,
"created_at": 1654841422226,
"updated_at": 1654841422226
},
{"id": "9a2c246b-4468-4888-8371-43fae8473296",
"name": "Testing Team",
"description": "This is the fourth team c",
"enabled": true,
"count_of_ous": 4,
"is_predefined": true,
"created_at": 1654841434865,
"updated_at": 1654841434865
}
],
"count": 4,
"_metadata": {"page_size": 1000,
"page": 0,
"has_next": false,
"total_count": 4
}
}

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

Payload
curl
Java
Go

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 multiple Collection categories

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

Payload
curl
Java
Go

application/json

["string"
]

Response samples

application/json

{"records": [{"id": "9a1dc856-6e2d-4dbe-98cf-5416c5981bbc",
"success": true
},
{"id": "eafb1e30-4af8-480e-b7b5-487293659df3",
"success": true
}
],
"count": 2
}

Update an existing Collection category

Use this API endpoint to update an existing collection category

Securityx-api-key

Request

path Parameters

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

Payload
curl
Java
Go

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 specific Collection category

Delete an existing collection category

Securityx-api-key

Request

path Parameters

required

string

The unique identifier of the collection category to be deleted

Responses

200

OK response.

delete/v1/org/categories/{id}

Request samples

curl
Java
Go

curl -X DELETE 'https://app.harness.io/gratis/sei/api/v1/org/categories/{id}' \
-H 'Content-Type: application/json' \
-H 'Authorization: API KEY <HARNESS_SEI_API_KEY>'

Response samples

application/json

{"records": [{"id": "9a2c246b-4468-4888-8371-43fae8473296",
"success": true
}
],
"count": 1
}

➔ Next to Collections