Policy >
Security
>
East West Security
>
Distributed Firewall
>
Settings
>
Firewall Identity Store
Get IDFW user login events for a given user
It will get IDFW user login events for a given user.
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/user-stats/<user-id>
Request Headers:
n/a
Query Parameters:
PolicyIdfwEnforcementPointRequestParameters
+
PolicyIdfwEnforcementPointRequestParameters
(
schema
)
Name
Description
Type
Notes
enforcement_point_path
String Path of the enforcement point
enforcement point path, forward slashes must be escaped using %2F.
string
Request Body:
n/a
Example Request:
GET https://<policy-ip>/policy/api/v1/infra/settings/firewall/idfw/user-stats/<user-id>
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IdfwUserStats
+
IdfwUserStats
(
schema
)
Name
Description
Type
Notes
active_sessions
List of active (still logged in) user login/sessions data (no limit)
array of
IdfwUserSessionData
Required
archived_sessions
List of archived (previously logged in) user login/session data
Optional list of up to 5 most recent archived (previously logged in) user
login/session data.
array of
IdfwUserSessionData
user_id
AD user Identifier (String ID)
string
Required
Readonly
Example Response:
{ "active_sessions": [{ "domain_name": "nimbustest.com", "vm_ext_id": "a6bc2d10-e98c-4a0c-a2e7-936eaec657e0", "user_id": { "is_valid": true, "target_type": "DirectoryUser", "target_id": "bee4cf12-9cb8-4b24-8604-a088d12efe0d" }, "user_name": "test6", "login_time": 1539209859091, "logout_time": 0, "user_session_id": 2 }], "user": { "is_valid": true, "target_type": "DirectoryUser", "target_id": "bee4cf12-9cb8-4b24-8604-a088d12efe0d" }, "archived_sessions": [{ "domain_name": "nimbustest.com", "vm_ext_id": "a6bc2d10-e98c-4a0c-a2e7-936eaec657e0", "user_id": { "is_valid": true, "target_type": "DirectoryUser", "target_id": "bee4cf12-9cb8-4b24-8604-a088d12efe0d" }, "user_name": "test6", "login_time": 1539209850318, "logout_time": 1539209852692, "user_session_id": 1 }] }
Required Permissions:
read
Feature:
policy_identity
Additional Errors:
404 Not Found
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable