System Administration > Settings > User Management > Vidm Configuration

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.

Request:

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

Example Request:

GET https://<policy-mgr>/policy/api/v1/aaa/vidm/users?search_string=John 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": "John_doe@testad2.local", "type": "remote_user", "display_name": "John Doe" }, { "name": "John_roe@testad2.local", "type": "remote_user", "display_name": "John Roe" } ] }

Required Permissions:

read

Feature:

users_role_assignments

Additional Errors: