NSX-T Data Center REST API

Associated URIs:

API Description API Path

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.


GET /policy/api/v1/aaa/vidm/groups
GET /api/v1/aaa/vidm/groups

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.


POST /policy/api/v1/aaa/vidm/search
POST /api/v1/aaa/vidm/search

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.


GET /policy/api/v1/aaa/vidm/users
GET /api/v1/aaa/vidm/users

Read AAA provider vIDM properties


GET /api/v1/node/aaa/providers/vidm
GET /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm

Update AAA provider vIDM properties


PUT /api/v1/node/aaa/providers/vidm
PUT /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm

Read AAA provider vIDM status


GET /api/v1/cluster/<cluster-node-id>/node/aaa/providers/vidm/status
GET /api/v1/node/aaa/providers/vidm/status