System Roles

In ThreatConnect, a user’s system role determines the system-level permissions that the user has on their ThreatConnect instance. These permissions cover access and functionalities on the following screens in the ThreatConnect UI: System Settings, Account Settings, TC Exchange™ Settings, Organization Settings, and Organization Config.

Endpoint: /api/v3/security/systemRoles

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/systemRoles endpoint, which is a read-only endpoint:

OPTIONS /v3/security/systemRoles?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/systemRoles endpoint:

OPTIONS /v3/security/systemRoles/tql

Retrieve System Roles

Retrieve All System Roles

Send the following request to retrieve data for all system roles:

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
        },
        {...}
    ],
    "status": "Success"
}

Retrieve a Specific System Role

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

GET /v3/security/systemRoles/{systemRoleId}

For example, the following request will retrieve data for the system role whose ID is 17:

GET /v3/security/systemRoles/17

JSON Response:

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

---

TC Exchange™ is a trademark of ThreatConnect, Inc.