Search for directory groups within a domain based on the substring of a distinguished name. (e.g. CN=User,DC=acme,DC=com) The search filter pattern can optionally support multiple (up to 100 maximum) search pattern separated by '|' (url encoded %7C). In this case, the search results will be returned as the union of all matching criteria. (e.g. CN=Ann,CN=Users,DC=acme,DC=com|CN=Bob,CN=Users,DC=acme,DC=com)
(Deprecated)
Deprecated: Use the following Policy API -
GET /policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/groups
Request:
URI Path(s):
/api/v1/directory/domains/{domain-id}/groups
Query Parameters:
DirectorySearchFilterValue+
cursor |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
string |
|
filter_value |
Name search filter value
Search filter value is a substring match pattern only which the target entity contains. It is case insentive and doesn't allow wildcard. |
string |
Required |
included_fields |
Comma separated list of fields that should be included in query result
Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs. |
string |
|
page_size |
Maximum number of results to return in this page (server may return fewer) |
integer |
Minimum: 0 Maximum: 1000 Default: "1000" |
sort_ascending |
|
boolean |
|
sort_by |
Field by which records are sorted |
string |
|
Example Request:
GET https://<nsx-mgr>/api/v1/directory/domains/123e4567-e89b-12d3-a456-42665544000/groups?filter_value=move
Successful Response:
Response Headers:
Content-type: application/json
Response Body:
DirectoryGroupListResults+
_links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
_schema |
Schema for this resource |
string |
Readonly |
_self |
Link to this resource |
SelfResourceLink |
Readonly |
cursor |
Opaque cursor to be used for getting next page of records (supplied by current result page) |
string |
Readonly |
result_count |
Count of results found (across all pages), set only on first page |
integer |
Readonly |
results |
Directory group list |
array of DirectoryGroup (Abstract type: pass one of the following concrete types) DirectoryAdGroup DirectoryGroup |
Required |
sort_ascending |
If true, results are sorted in ascending order |
boolean |
Readonly |
sort_by |
Field by which records are sorted |
string |
Readonly |
Example Response:
{
"sort_ascending": true,
"sort_by": "display_name",
"result_count": 2,
"results": [
{
"resource_type": "DirectoryGroup",
"id": "a436e3ca-cf95-444e-bfa9-c36462063c02",
"display_name": "movegrp1",
"domain_id": "63329cea-99ae-4060-a5ae-f0da6ab67ef6",
"distinguished_name": "CN=movegrp1,CN=Users,DC=nimbustest,DC=com",
"_create_user": "system",
"_create_time": 1516656516152,
"_last_modified_user": "system",
"_last_modified_time": 1516656517034,
"_system_owned": false,
"_protection": "NOT_PROTECTED",
"_revision": 1
},
{
"resource_type": "DirectoryGroup",
"id": "ff56d298-8a9d-4da2-81ac-043f34fd2e15",
"display_name": "movegrp2",
"domain_id": "63329cea-99ae-4060-a5ae-f0da6ab67ef6",
"distinguished_name": "CN=movegrp2,CN=Users,DC=nimbustest,DC=com",
"_create_user": "system",
"_create_time": 1516656516151,
"_last_modified_user": "system",
"_last_modified_time": 1516656517034,
"_system_owned": false,
"_protection": "NOT_PROTECTED",
"_revision": 1
}
]
}
Required Permissions:
read
Feature:
directory_service
Additional Errors: