Owner Roles

An owner role is a user’s role within a specific Organization, Community, or Source in ThreatConnect and determines the permissions that the user has within that Organization, Community, or Source.

Endpoint: /api/v3/security/ownerRoles

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

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

OPTIONS /v3/security/ownerRoles/tql

Retrieve Owner Roles

Retrieve All Owner Roles

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

GET /v3/security/ownerRoles

JSON Response:

{
    "data": [
        {
            "id": 1,
            "name": "User",
            "descriptionComm": "Read only access to all data",
            "descriptionAdmin": "Read only access to all data",
            "orgRole": false,
            "commRole": true,
            "version": 1,
            "available": true
        },
        {
            "id": 2,
            "name": "Commenter",
            "descriptionComm": "Post creation",
            "descriptionAdmin": "Post creation",
            "orgRole": false,
            "commRole": true,
            "version": 1,
            "available": true
        },
        {
            "id": 3,
            "name": "Contributor",
            "descriptionComm": "Indicator, Group, and Tag creation",
            "descriptionAdmin": "Indicator, Group, and Tag creation",
            "orgRole": false,
            "commRole": true,
            "version": 1,
            "available": true
        },
        {...}
    ],
    "status": "Success"
}

Retrieve a Specific Owner Role

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

GET /v3/security/ownerRoles/{ownerRoleId}

For example, the following request will retrieve data for the owner role whose ID is 15, which is a custom owner role:

GET /v3/security/ownerRoles/15

JSON Response:

{
    "data": {
        "id": 15,
        "name": "Example Org Custom Role",
        "descriptionOrg": "This is an example custom role. Do not use.",
        "descriptionAdmin": "This is an example custom role for an Organization.",
        "orgRole": true,
        "commRole": false,
        "available": true
    },
    "status": "Success"
}