System Roles

A user’s System role in ThreatConnect determines the System-level permissions that they have on their instance of ThreatConnect. These permissions cover access and functionalities on each of the following screens: System Settings, Account Settings, TC Exchange™ Settings, Organization Settings, and Organization Config.

Endpoint: /api/v3/security/systemRoles

Available Fields

A list of valid fields for the v3/security/systemRoles endpoint, which is a read-only endpoint, can be retrieved using the following query:

OPTIONS /v3/security/systemRoles?show=readonly

Retrieve System Roles

Retrieve All System Roles

To retrieve all system roles in your ThreatConnect instance, use the following query:

GET /v3/security/systemRoles

JSON Response:

{
    "data": [
        {
            "id": 1,
            "name": "User",
            "active": true,
            "assignable": true,
            "displayed": true
        },
        {
            "id": 2,
            "name": "Administrator",
            "active": true,
            "assignable": true,
            "displayed": true
        },
        {
            "id": 6,
            "name": "Operations Administrator",
            "active": true,
            "assignable": true,
            "displayed": true
        },
        {
            "id": 9,
            "name": "Api User",
            "active": true,
            "assignable": false,
            "displayed": false
        },
        {
            "id": 10,
            "name": "Accounts Administrator",
            "active": true,
            "assignable": true,
            "displayed": true
        },
    {...}
    ],
    "status": "Success"
}

Retrieve a Single System Role

To retrieve a specific system role in your ThreatConnect instance, use a query in the following format:

GET /v3/security/systemRoles/{systemRoleId}

For example, the following query will return information about the system role with ID 17:

GET /v3/security/systemRoles/17

JSON Response:

{
    "data": {
        "id": 17,
        "name": "Read Only User",
        "active": true,
        "assignable": true,
        "displayed": true
    },
    "status": "Success"
}

Filter Results

To filter returned objects using ThreatConnect Query Language (TQL), refer to Filter Results with TQL.


TC Exchange™ is a trademark of ThreatConnect, Inc.