Qodex.ai

List access groups

GET {{baseUrl}}/access-groups?f=deserunt&ft=deserunt&w=deserunt&wf=deserunt&limit=67454373&offset=67454373&sort=deserunt

Lists access groups without associated rules.

Note: Access Groups v1 continues to be supported. However, Tenable recommends using Access Groups v2.

Requires BASIC [16] user permissions to list access groups to which you are assigned. Requires ADMINISTRATOR [64] permissions to list all access groups for your organization. See Permissions.

Request Params

KeyDatatypeRequiredDescription
fstringA filter condition in the following format: field:operator:value. For a list of possible fields and operators, use the GET /access-groups/filters endpoint. You can specify multiple f parameters, separated by ampersand (&) characters. If you specify multiple f parameters, use the ft parameter to specify how Tenable.io applies the multiple filter conditions.
ftstringIf multiple `f` parameters are present, specifies whether Tenable.io applies `AND` or `OR` to conditions. Supported values are and and or. If you omit this parameter when using multiple f parameters, Tenable.io applies AND by default.
wstringThe search value that Tenable.io applies across the wildcard fields. Wildcard fields are specified in the wf parameter.
wfstringA comma-separated list of fields where Tenable.io applies the search value specified in the w parameter. For a list of supported wildcard fields, use the GET /access-groups/filters endpoint.
limitnumberThe number of records to retrieve.
offsetnumberThe starting record to retrieve. If this parameter is omitted, Tenable.io uses the default value of 0.
sortstringThe field you want to use to sort the results by along with the sort order. The field is specified first, followed by a colon, and the order is specified second (asc or desc). For example, name:desc would sort results by the name field in descending order.

If you specify multiple fields, the fields must be separated by commas. For example, name:desc,created_at:asc would first sort results by the name field in descending order and then by the created_at field in ascending order.

For a list of supported sort fields, use the GET /access-groups/filters endpoint. |

RESPONSES

status: OK

{"access_groups":[{"container_uuid":"8f9d0b84-ede2-4954-a0c9-0bde292ac38e","created_at":"2018-11-31T21:26:00.397Z","updated_at":"2018-12-31T21:26:00.397Z","id":"529d57cf-bbc6-435f-9b57-896bb40bba8c","name":"Atlanta Office","all_assets":false,"all_users":false,"status":"COMLETED","created_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_uuid":"b1219ca2-2578-49ac-88db-8a35dd02cc7d","updated_by_name":"user@example.com","created_by_name":"user@example.com","processing_percent_complete":100}],"pagination":{"offset":0,"limit":2,"total":7,"sort":[{"name":"allAssets","order":"desc"},{"name":"updatedAt","order":"asc"}]}}