Owner Roles¶
An owner role is a user’s role within a specific Organization, Community, or Source in ThreatConnect. The user’s owner role determines the permissions they have within that Organization, Community, or Source.
Endpoint: /api/v3/security/ownerRoles
Available Fields¶
A list of fields for the v3/security/ownerRoles
endpoint, which is a read-only endpoint, can be retrieved using the following query:
OPTIONS /v3/security/ownerRoles?show=readonly
Retrieve Owner Roles¶
Retrieve All Owner Roles¶
To retrieve all owner roles, including custom owner roles, in your ThreatConnect instance, use the following query:
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 Single Owner Role¶
To retrieve a specific owner role in your ThreatConnect instance, use a query in the following format:
GET /v3/security/ownerRoles/{ownerRoleId}
For example, the following query will return information about the owner role with ID 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"
}
Filter Results¶
To filter returned objects using ThreatConnect Query Language (TQL), refer to Filter Results with TQL.