List access groups
GET {{baseUrl}}/v2/access-groups?f=deserunt&ft=deserunt&w=deserunt&wf=deserunt&limit=67454373&offset=67454373&sort=deserunt
Lists access groups without associated rules.
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
| Key | Datatype | Required | Description |
|---|---|---|---|
f | string | A filter condition in the following format: field:operator:value. For a list of possible fields and operators, use the GET /v2/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. | |
ft | string | If 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. | |
w | string | The search value that Tenable.io applies across the wildcard fields. Wildcard fields are specified in the wf parameter. | |
wf | string | A 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 /v2/access-groups/filters endpoint. | |
limit | number | The number of records to retrieve. | |
offset | number | The starting record to retrieve. If this parameter is omitted, Tenable.io uses the default value of 0. | |
sort | string | The 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 /v2/access-groups/filters endpoint. |
RESPONSES
status: OK
{"access_groups":[{"container_uuid":"7a818eb1-8351-4795-99b0-9610c8954cb4","created_at":"2018-10-31T13:18:29.185Z","updated_at":"2020-04-09T06:48:22.024Z","id":"bffd4423-b6cc-47f0-8428-291179961507","name":"All Assets","all_assets":true,"version":5,"status":"COMPLETED","access_group_type":"ALL","principals":[{"type":"all_users","principal_id":"00000000-0000-0000-0000-000000000000","principal_name":"All Users","permissions":["CAN_SCAN"]}],"created_by_name":"system","processing_percent_complete":100},{"container_uuid":"7a818eb1-8351-4795-99b0-9610c8954cb4","created_at":"2018-11-27T21:17:18.883Z","updated_at":"2018-11-27T22:12:02.414Z","id":"d30542aa-84d4-4b38-9a74-6a4c665532b2","name":"Western Region","all_assets":false,"version":2,"status":"COMPLETED","access_group_type":"MANAGE_ASSETS","principals":[{"type":"all_users","principal_id":"00000000-0000-0000-0000-000000000000","principal_name":"All Users","permissions":[]},{"type":"user","principal_id":"e7ecb50b-1330-4a8c-b8e5-ee00ec8c46f8","principal_name":"user1@example.com","permissions":["CAN_VIEW"]},{"type":"user","principal_id":"a7162cb4-ebf7-4103-a250-34b1777cfbd1","principal_name":"user2@example.com","permissions":["CAN_VIEW"]}],"created_by_uuid":"f3eda8e9-11f5-4ac8-966f-b758eed531c5","updated_by_uuid":"f3eda8e9-11f5-4ac8-966f-b758eed531c5","updated_by_name":"user1@example.com","created_by_name":"user1@example.com","processing_percent_complete":100},{"container_uuid":"7a818eb1-8351-4795-99b0-9610c8954cb4","created_at":"2019-05-31T20:11:14.122Z","updated_at":"2019-05-31T20:11:14.122Z","id":"84dc897b-401b-498d-95c1-c5f6a1c3fee6","name":"networks-uuid-test","all_assets":false,"version":1,"status":"COMPLETED","access_group_type":"MANAGE_ASSETS","principals":[{"type":"all_users","principal_id":"00000000-0000-0000-0000-000000000000","principal_name":"All Users","permissions":["CAN_VIEW"]}],"created_by_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","updated_by_uuid":"08d242c3-9553-4ccc-835d-0c17ed942cdf","updated_by_name":"user1@example.com","created_by_name":"user1@example.com","processing_percent_complete":100}],"pagination":{"offset":0,"total":17,"sort":[{"name":"allAssets","order":"desc"}]}}