List members of a directory group

A member group could be either direct member of the group specified by group_id or nested member of it. Both direct member groups and nested member groups are returned. Directory group member sync must be enabled to get the correct results.

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/firewall-identity-stores/<firewall-identity-store-id>/groups/<group-id>/member-groups

Request Headers:

n/a

Query Parameters:

FirewallIdentityStoreListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
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

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/firewall-identity-stores/123e4567-e89b-12d3-a456-42665544000/groups/1abfda06-fc00-11e7-8450-fea9aa178066/member-groups

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DirectoryGroupMemberListResults+

Name	Description	Type	Notes
_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 member list	array of DirectoryGroupMember	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": 1, "results": [ { "resource_type": "DirectoryGroupMember", "id": "877c5fd0-7ee2-424e-9bff-66a169f6ded4", "display_name": "877c5fd0-7ee2-424e-9bff-66a169f6ded4", "group_id": "1bd85e69-6eac-416c-80c0-bd8203d76146", "group_distinguished_name": "CN=test6grp,CN=Users,DC=nimbustest,DC=com", "member_group_id": "2cab9258-3413-4787-8d9e-60986985cd3a", "member_group_distinguished_name": "CN=test5grp,CN=Users,DC=nimbustest,DC=com", "_last_modified_user": "system", "_last_modified_time": 1516663042822, "_system_owned": false, "_create_user": "system", "_create_time": 1516661730906, "_protection": "NOT_PROTECTED", "_revision": 1 } ] }

List members of a directory group

Request:

FirewallIdentityStoreListRequestParameters (schema)

Example Request:

Successful Response:

DirectoryGroupMemberListResults (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: