NSX-T Data Center REST API

Get all the User Groups where vIDM display name matches the search key case insensitively. The search key is checked to be a substring of display name. This is a non paginated API. This API will return as many results that vIDM returns to NSX during the search query. vIDM may not send all results at once so to zero in on the group of interest more characters need to be entered.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/aaa/vidm/groups
/api/v1/aaa/vidm/groups
Request Headers:
n/a
Query Parameters:
VidmInfoSearchRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/aaa/vidm/groups?search_string=clay_group

Successful Response:

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

Example Response:

{ "result_count": 3, "results": [ { "name": "[email protected]", "type": "remote_group", "display_name": "[email protected]" }, { "name": "[email protected]", "type": "remote_group", "display_name": "[email protected]" }, { "name": "[email protected]", "type": "remote_group", "display_name": "[email protected]" } ] }

Required Permissions:

read

Feature:

users_role_assignments

Additional Errors: