NSX-T Data Center REST API

List users by user name

Return all the users based on the user name.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/identity-firewall-stores/{identity-firewall-store-id}/users
Request Headers:
n/a
Query Parameters:
FirewallIdentitySearchFilterValue+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/identity-firewall-stores/idstore-1/users?filter_value=usr

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
IdentityFirewallStoreUserOrGrouptListResults+

Example Response:

{ "results": [ { "resource_type": "DirectoryUser", "domain_id": "firewall-id-1", "domain_name": "DC=testad3,DC=local", "distinguished_name": "CN=usr1,OU=xyz,DC=testad3,DC=local", "id": "b2857fe5-c91e-4c59-a5e0-b8635aa8c4a9", "display_name": "usr1", "_create_time": 1669790018212, "_create_user": "system", "_last_modified_time": 1669790018212, "_last_modified_user": "system", "_system_owned": false, "_revision": 0 } ], "result_count": 1 }

Required Permissions:

read

Feature:

policy_identity

Additional Errors: