NSX-T Data Center REST API

Get all the users from vIDM whose userName, givenName or familyName matches the search key case insensitively. The search key is checked to be a substring of name or given name or family 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 user of interest more characters need to be entered.

Request:

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

Example Request:

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

Successful Response:

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

Example Response:

{ "result_count": 2, "results": [ { "name": "[email protected]", "type": "remote_user", "display_name": "John Doe" }, { "name": "[email protected]", "type": "remote_user", "display_name": "John Roe" } ] }

Required Permissions:

read

Feature:

users_role_assignments

Additional Errors: