NSX-T Data Center REST API

Get all the users and groups from vIDM matching the search key case insensitively. The search key is checked to be a substring of name or given name or family name of user and display name of group. 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 user/group of interest more characters need to be entered.

Request:

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

Example Request:

POST https://<nsx-mgr>/api/v1/aaa/vidm/search?search_string=John

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_user", "display_name": "John Doe" }, { "name": "[email protected]", "type": "remote_user", "display_name": "John Roe" }, { "name": "[email protected]", "type": "remote_group", "display_name": "John's Group" } ] }

Required Permissions:

read

Feature:

users_role_assignments

Additional Errors: