Tenable Security Center API: Director User

This API resource is only available for administrators in Tenable.sc Director.

mgmt/user

Methods

GET

Gets the list of Users on Tenable.sc Instances linked to Director.

Fields Parameter

Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
*uuid
*sciUserID
*sciRoleID
*sciGroupID
*SCI
*organization
**username
**firstname
**lastname
email
title
address
city
state
country
phone
fax

Legend

* = always comes back

** = comes back if fields list not specified

red = field is a JSON object ( e.g. "SCI" : {"id" : "2", "name" : "SCI Name", "description" : "Description"} )

Request User Parameters

Expand

The id and orgID are the IDs stored in the tables local to Director. They must match ID values found with /mgmt/user and /mgmt/organization endpoints, unless you want to filter on Administrator users, in which case you can provide an orgID of "0".

To see a list of all users on a particular Tenable.sc Instance, the sciID parameter should be specified along the query string, and it takes the syntax

	?sciID=<number>

To see a list of all users on a particular Organization, the orgID parameter should be specified along the query string. To see a list of all Administrator users, an orgID of "0" should be specified along the query string. This can be used in combination with the sciID filter to see a list of Administrator users for a particular Tenable.sc instance. This filter takes the syntax

	?orgID=<number>

Example Response

Expand

{
    "type": "regular",
    "response": [
        {
            "id": "1",
            "uuid": "875A7270-E6B1-4FBF-A12E-1381DAED1A99",
            "sciUserID": "1",
            "sciRoleID": "1",
            "sciGroupID": "-1",
            "username": "admin",
            "firstname": "Admin",
            "lastname": "User",
            "email": "",
            "SCI": {
                "id": "2",
                "name": "SCI 1",
                "description": "123"
            },
            "organization": {
                "id": "0",
                "name": "Administrator",
                "description": ""
            }
        },
        {
            "id": "2",
            "uuid": "AB1D4170-E362-4637-AE7C-F29D77B37A8F",
            "sciUserID": "1",
            "sciRoleID": "2",
            "sciGroupID": "0",
            "username": "qa",
            "firstname": "Organization",
            "lastname": "User",
            "email": "",
            "SCI": {
                "id": "2",
                "name": "SCI 1",
                "description": "123"
            },
            "organization": {
                "id": "1",
                "name": "Org 1",
                "description": ""
            }
        }
    ],
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1644240279
}

/mgmt/user/{id}

/mgmt/user/{uuid}

Methods

GET

Gets the User associated with {id} or {uuid}.

The id is the ID stored in a table local to Director. It must match an ID value found with the /mgmt/user endpoint.

Fields Parameter

Expand

The fields parameter should be specified along the query string, and it takes the syntax

    ?fields=<field>,...

Allowed Fields

*id
*uuid
*sciUserID
*sciRoleID
*sciGroupID
*SCI
*organization
**username
**firstname
**lastname
**email
**title
**address
**city
**state
**country
**phone
**fax

Legend

* = always comes back

** = comes back if fields list not specified

red = field is a JSON object ( e.g. "SCI" : {"id" : "2", "name" : "SCI Name", "description" : "Description"} )

Request User Parameters

None

Example Response

Expand

{
   "type": "regular",
    "response": {
        "id": "2",
        "uuid": "AB1D4170-E362-4637-AE7C-F29D77B37A8F",
        "sciUserID": "1",
        "sciRoleID": "2",
        "sciGroupID": "0",
        "username": "qa",
        "firstname": "QA",
        "lastname": "User",
        "title": "",
        "email": "",
        "address": "",
        "city": "",
        "state": "",
        "country": "",
        "phone": "",
        "fax": "",
        "SCI": {
            "id": "2",
            "name": "SCI 1",
            "description": "123"
        },
        "organization": {
            "id": "1",
            "name": "Org 1",
            "description": ""
        }
    },
    "error_code": 0,
    "error_msg": "",
    "warnings": [],
    "timestamp": 1644240550
}