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

Endpoint Options

Available Fields

Send the following request to retrieve a complete list of fields that may be included in responses returned from the /v3/security/owners endpoint, which is a read-only endpoint:

OPTIONS /v3/security/owners?show=readonly

Filter Results

When retrieving data, you can use the tql query parameter to filter results with ThreatConnect Query Language (TQL).

Send the following request to retrieve a list of valid TQL parameters you can use when including the tql query parameter in a request to the /v3/security/owners endpoint:

OPTIONS /v3/security/owners/tql

Retrieve Owners

Retrieve All Owners

Send the following request to retrieve data for all owners:

GET /v3/security/owners

JSON Response:

{
    "data": [
        {
            "id": 2,
            "name": "Demo Source",
            "type": "Source",
            "ownerRole": "Director",
            "permIndicator": "FULL",
            "permGroup": "FULL",
            "permPost": "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",
            "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",
            "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 Specific Owner

Send a request in the following format to retrieve data for a specific owner:

GET /v3/security/owners/{ownerId}

For example, the following request will retrieve data for the owner whose ID is 3:

GET /v3/security/owners/3

JSON Response:

{
    "data": {
        "id": 3,
        "name": "Demo Community",
        "type": "Community",
        "ownerRole": "Director",
        "permIndicator": "FULL",
        "permGroup": "FULL",
        "permPost": "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"
}