Client Object

Client objects contain the client's details and are one of the highest-level objects in the database, as all other objects are within the context of a specific client.

The client object does not hold a list of assets or reports; instead, each asset and report contains the ID of a client.

Clients hold a list of client assets representing a physical asset or web application. This list is dynamically populated as files with assets imported via a scan or manually added within PlexTrac.

Client Table

The following table explains the fields and data types stored for a client. Fields are presented in alphabetical order by object field name.

The name field is the only required field when creating a client.

object field name	description	data type
client_id	UUID of client	integer
classificationId	CUID of the Classification Level for an authorized user for each client	string or null
custom_field	custom fields related to client	array[ { "label": str, "value": str } ]
custom_field/label	label of the custom field	string
custom_field/value	plain text value of the custom field	string
description	description of client	string
doc_type	field in database to identify object	"client": DB type identifier
name	name of Client	string
poc	point of contact for client	string
poc_email	email address of point of contact	string
role	type of role of user associated with a client; will be one of three values to represent roles of Administrator, Standard User, and Analyst	string containing one of the following values: ["ADMIN", "STD_USER", "ANALYST"]
tenant_id	UUID of tenant	integer
users	list of users and roles within a client	dict { str: user email: Dict{ "classificationId": str || null: CUID, "role": str: ["ADMIN", "STD_USER", "ANALYST"] } }
tags	any tags associated with a client	string array

Client Structure

The client object stored in the database is a nested JSON object. Below is a screenshot and sample downloadable file that displays the structure of database objects.

439B

Client Object.txt