Get Group Vidm Search Result

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.

Request

URI

GET

https://nsxmanager.your.domain/api/v1/aaa/vidm/groups

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 to result of query

integer

page_size

Optional

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

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Success

Returns VidmInfoListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineVidmInfoListResult1

{
    "_self": {
        "rel": "string"
    },
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "cursor": "string",
    "sort_ascending": false,
    "sort_by": "string",
    "result_count": 0,
    "results": [
        {
            "display_name": "string",
            "type": "string",
            "name": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json

Operation doesn't return any data structure

403

Returns Forbidden of type(s) application/json

Operation doesn't return any data structure

404

Returns NotFound of type(s) application/json

Operation doesn't return any data structure

412

Returns PreconditionFailed of type(s) application/json

Operation doesn't return any data structure