Owners¶
Every piece of data in ThreatConnect has an owner. Owners have full control over the data they own, and they fall under one of three categories: Organization, Community, or Source.
Endpoint: /api/v3/security/owners
Available Fields¶
A list of fields for the v3/security/owners
endpoint, which is a read-only endpoint, can be retrieved using the following query:
OPTIONS /v3/security/owners?show=readonly
Retrieve Owners¶
Retrieve All Owners¶
To retrieve all owners in the Organization in which your API user account resides, use the following query:
GET /v3/security/owners
JSON Response:
{
"data": [
{
"id": 2,
"name": "Demo Source",
"type": "Source",
"ownerRole": "Director",
"permIndicator": "FULL",
"permGroup": "FULL",
"permPost": "FULL",
"permTrack": "FULL",
"permVictim": "FULL",
"permAttribute": "FULL",
"permApps": "NONE",
"permUsers": "FULL",
"permSecurityLabel": "FULL",
"permTag": "FULL",
"permAttributeType": "FULL",
"permSettings": "FULL",
"permMembers": "FULL",
"permCopyData": "FULL",
"permInvite": "FULL",
"permTask": "NONE",
"permCaseTag": "NONE",
"permArtifact": "NONE",
"permComment": "NONE",
"permTimeline": "NONE",
"permWorkflowTemplate": "NONE",
"permPublish": "FULL",
"permPlaybooksExecute": "NONE",
"permPlaybooks": "NONE"
},
{
"id": 3,
"name": "Demo Community",
"type": "Community",
"ownerRole": "Director",
"permIndicator": "FULL",
"permGroup": "FULL",
"permPost": "FULL",
"permTrack": "FULL",
"permVictim": "FULL",
"permAttribute": "FULL",
"permApps": "NONE",
"permUsers": "FULL",
"permSecurityLabel": "FULL",
"permTag": "FULL",
"permAttributeType": "FULL",
"permSettings": "FULL",
"permMembers": "FULL",
"permCopyData": "FULL",
"permInvite": "FULL",
"permTask": "NONE",
"permCaseTag": "NONE",
"permArtifact": "NONE",
"permComment": "NONE",
"permTimeline": "NONE",
"permWorkflowTemplate": "NONE",
"permPublish": "FULL",
"permPlaybooksExecute": "NONE",
"permPlaybooks": "NONE"
},
{
"id": 1,
"name": "Demo Organization",
"type": "Organization",
"ownerRole": "Organization Administrator",
"permIndicator": "FULL",
"permGroup": "FULL",
"permPost": "FULL",
"permTrack": "FULL",
"permVictim": "FULL",
"permAttribute": "FULL",
"permApps": "BUILD",
"permUsers": "FULL",
"permSecurityLabel": "FULL",
"permTag": "FULL",
"permAttributeType": "FULL",
"permSettings": "FULL",
"permMembers": "READ",
"permCopyData": "FULL",
"permInvite": "FULL",
"permTask": "FULL",
"permCaseTag": "FULL",
"permArtifact": "FULL",
"permComment": "FULL",
"permTimeline": "FULL",
"permWorkflowTemplate": "FULL",
"permPublish": "FULL",
"permPlaybooksExecute": "FULL",
"permPlaybooks": "FULL"
},
{...}
],
"status": "Success"
}
Retrieve a Single Owner¶
To retrieve a specific owner in the Organization in which your API user account resides, use a query in the following format:
GET /v3/security/owners/{ownerId}
For example, the following query will return information about the owner with ID 3:
GET /v3/security/owners/3
JSON Response:
{
"data": {
"id": 3,
"name": "Demo Community",
"type": "Community",
"ownerRole": "Director",
"permIndicator": "FULL",
"permGroup": "FULL",
"permPost": "FULL",
"permTrack": "FULL",
"permVictim": "FULL",
"permAttribute": "FULL",
"permApps": "NONE",
"permUsers": "FULL",
"permSecurityLabel": "FULL",
"permTag": "FULL",
"permAttributeType": "FULL",
"permSettings": "FULL",
"permMembers": "FULL",
"permCopyData": "FULL",
"permInvite": "FULL",
"permTask": "NONE",
"permCaseTag": "NONE",
"permArtifact": "NONE",
"permComment": "NONE",
"permTimeline": "NONE",
"permWorkflowTemplate": "NONE",
"permPublish": "FULL",
"permPlaybooksExecute": "NONE",
"permPlaybooks": "NONE"
},
"status": "Success"
}
Filter Results¶
To filter returned objects using ThreatConnect Query Language (TQL), refer to Filter Results with TQL.