NSX-T Data Center REST API

Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)

Request:

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

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/123e4567-e89b-12d3-a456-42665544000/groups?filter_value=move

Successful Response:

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

Example Response:

{ "sort_ascending": true, "sort_by": "display_name", "result_count": 2, "results": [ { "resource_type": "DirectoryGroup", "id": "a436e3ca-cf95-444e-bfa9-c36462063c02", "display_name": "movegrp1", "domain_id": "63329cea-99ae-4060-a5ae-f0da6ab67ef6", "distinguished_name": "CN=movegrp1,CN=Users,DC=nimbustest,DC=com", "_create_user": "system", "_create_time": 1516656516152, "_last_modified_user": "system", "_last_modified_time": 1516656517034, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 }, { "resource_type": "DirectoryGroup", "id": "ff56d298-8a9d-4da2-81ac-043f34fd2e15", "display_name": "movegrp2", "domain_id": "63329cea-99ae-4060-a5ae-f0da6ab67ef6", "distinguished_name": "CN=movegrp2,CN=Users,DC=nimbustest,DC=com", "_create_user": "system", "_create_time": 1516656516151, "_last_modified_user": "system", "_last_modified_time": 1516656517034, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 } ] }

Required Permissions:

read

Feature:

policy_identity

Additional Errors: