Get all IDFW Group VM details for a given Group

Get all Identity Firewall Group VM details for a given Group.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX-T.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/settings/firewall/idfw/group-vm-details

Request Headers:

n/a

Query Parameters:

PolicyIdfwGroupRequestParameters+

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
group_path	String Path of the group Group path, forward slashes must be escaped using %2F.	string	Required

Request Body:

n/a

Example Request:

GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/group-vm-details?group_path=/infra/domains/default/groups/idfw-grp-1

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyIdfwGroupVmDetailListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
group_path	String Path of the group String Path of the group	string
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	List of user login/session data for a single VM	array of IdfwVmDetail
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "group_path": "/infra/domains/default/idfw-grp-1", "results": [ { "vm_ext_id": "501ae853-9b09-69e3-394a-1af06f7dbfec", "user_sessions": [ { "id": "9540cd6d-8d46-4c20-b2cc-491efc005865", "domain_name": "IDFW0", "user_name": "administrator", "user_id": "10446e86-99c1-43a7-8345-fda90c56291c", "vm_ext_id": "501ae853-9b09-69e3-394a-1af06f7dbfec", "user_session_id": 2, "login_time": 1589165250502, "logout_time": 0 } ] } ], "result_count": 1 }

Get all IDFW Group VM details for a given Group

Request:

PolicyIdfwGroupRequestParameters (schema)

Example Request:

Successful Response:

PolicyIdfwGroupVmDetailListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: