Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141784109.3 KB

Returns group information for the specified directory.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the ListGroups.NextToken member contains a token that you pass in the next call to ListGroups. This retrieves the next set of items.

You can also specify a maximum number of return results with the MaxResults parameter.

post/Groups/ListGroups#DirectoryId

Query parameters

DirectoryIdstring required

The identifier (ID) of the directory that's associated with the group.

Request body

MaxResultsinteger

The maximum number of results to be returned per request.

NextTokenstring password

An encoded paging token for paginated calls that can be passed back to retrieve the next page.

Realmstring
<p> The domain name associated with the directory. </p> <note> <p> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </p> <p> This value is case insensitive. </p> </note>

Response

Success

DirectoryIdstring

The identifier (ID) of the directory that's associated with the group.

NextTokenstring password

An encoded paging token for paginated calls that can be passed back to retrieve the next page.

Realmstring

The domain name associated with the group.