Get Vidm Search Result
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
URI
POST
https://nsxmanager.your.domain/api/v1/aaa/vidm/search
COPY
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
included_fields
Optional
Comma separated list of fields that should be included in query result
integer
page_size
Optional
Constraints:
minimum: 0
maximum: 1000
default: 1000
Maximum number of results to return in this page (server may return fewer)
string
search_string
Required
Search string to search for.
boolean
sort_ascending
Optional
sort_ascending
string
sort_by
Optional
Field by which records are sorted
Responses
200
OK
Returns
VidmInfoListResult
of type(s)
application/json
This response body class contains all of the following:
InlineVidmInfoListResult1
{
"_links": [
{
"action": "string",
"href": "string",
"rel": "string"
}
],
"_schema": "string",
"_self": {},
"cursor": "string",
"result_count": 0,
"sort_ascending": false,
"sort_by": "string",
"results": [
{
"display_name": "string",
"name": "string",
"type": "string"
}
]
}
412
Returns
PreconditionFailed
of type(s)
application/json
Operation doesn't return any data structure
500
Returns
InternalServerError
of type(s)
application/json
Operation doesn't return any data structure
503
Returns
ServiceUnavailable
of type(s)
application/json
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/aaa/vidm/search
System Administration Operations
GET
List Features
POST
Create Registration Token
POST
Remove Registration Token
POST
Retrieve Registration Token
DELETE
Delete Registration Token
Deprecated
GET
Get Registration Token
Deprecated
GET
Get All Role Bindings
POST
Create Role Binding
DELETE
Delete Role Binding
GET
Get Role Binding
PUT
Update Role Binding
POST
Delete All Stale Role Bindings
GET
Get All Roles Info
GET
List Roles Info
DELETE
Delete Role
GET
Get Role Info
PUT
Create Or Update Role
PUT
Update Role Assignment Config
POST
Clone Role
POST
Validate And Recommend Permissions
GET
Get Current User Info
GET
Get Group Vidm Search Result
POST
Get Vidm Search Result
GET
Get User Vidm Search Result
GET
Get Support Bundle Config
PUT
Update Support Bundle Config
GET
Get Dynamic Content Filter Values
POST
Collect Support Bundles Collect
POST
Delete Support Bundles Async Response Delete Async Response
GET
Cluster Cluster Node Id Node Read Auth Provider Vidm
PUT
Cluster Cluster Node Id Node Update Auth Provider Vidm
GET
Cluster Cluster Node Id Node Read Auth Provider Vidm Status
POST
Accept EULA
GET
Get EULA Acceptance
GET
Get EULA Content
GET
Get License
Deprecated
PUT
Update License
Deprecated
GET
Get Licenses
POST
Create License
GET
Get License Usage Report
GET
Get License Usage Report In Csv Format
GET
Get Security License Usage Report
GET
Get Security License Usage Report In Csv Format
POST
Deprecated Sync VCF Licenses
Deprecated
POST
Sync VCF Licenses
DELETE
Delete License
Deprecated
GET
Get License By Key
Deprecated
POST
Delete License Key
GET
Node Read Auth Provider Vidm
PUT
Node Update Auth Provider Vidm
GET
Node Read Auth Provider Vidm Status
GET
Get Proxy Config
PUT
Update Proxy Config
POST
Create Sensor Registration Token
GET
Get Telemetry Agreement
PUT
Update Telemetry Agreement
GET
Get Telemetry Config
PUT
Update Telemetry Config
GET
Get Trust Objects
GET
Get Certificate Profile
GET
List Certificate Profiles
GET
Get Certificates
POST
Batch Replace Certificates
POST
Renew Appliance Certificates
POST
Replace Host Certificate
DELETE
Delete Certificates Batch Operation Result
GET
Get Certificates Batch Operation Result
POST
Add Trusted Ca Certificate
DELETE
Delete Certificate
GET
Get Certificate
POST
Apply Certificate
GET
Validate Certificate
POST
Fetch Peer Certificate Chain
POST
Add Certificate
POST
Set Inter Site Aph Certificate
Deprecated
POST
Set Principal Identity Certificate For Federation
Deprecated
GET
List Crl Distribution Points
POST
Create Crl Distribution Point
POST
Get Crl Distribution Point Pem
DELETE
Delete Crl Distribution Point
GET
Get Crl Distribution Point
PUT
Update Crl Distribution Point
GET
Get Crl Distribution Point Status
GET
Get Crls
DELETE
Delete Crl
GET
Get Crl
PUT
Update Crl
POST
Add Crl
GET
Get Csrs
POST
Generate Csr
POST
Generate Csr With Extensions
Deprecated
DELETE
Delete Csr
GET
Get Csr
GET
Get Csr Pem
POST
Import Certificate
POST
Self Sign Certificate
POST
Generate Self Signed Certificate
GET
List Oidc End Points
POST
Add Oidc End Point
POST
Configure Ws1b And Add Oidc End Point
POST
Remove Ws1b Oidc End Point
GET
Get Oidc End Point
PUT
Update Oidc End Point
GET
Check Oidc End Point Health
POST
Search Scim Users And Groups
GET
Verify Scim User Or Group Exists
POST
Refresh Oidc End Point
POST
Update Oidc End Point Thumbprint
GET
Get Principal Identities
POST
Register Principal Identity
Deprecated
POST
Register Principal Identity With Certificate
DELETE
Delete Principal Identity
GET
Get Principal Identity
POST
Update Principal Identity Certificate
GET
Get Stale Certificates
GET
List Token Based Principal Identities
POST
Register Token Based Principal Identity
DELETE
Delete Token Based Principal Identity
GET
Get Token Based Principal Identity