Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141784109.3 KB

Searches the specified directory for a group. You can find groups that match the SearchString parameter with the value of their attributes included in the SearchString parameter.

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

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

post/Groups/SearchGroups#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 that's associated with the group. </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>
SearchAttributesLdapDisplayName[] required

One or more data attributes that are used to search for a group. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>.

SearchStringstring password required
<p> The attribute value that you want to search for. </p> <note> <p> Wildcard <code>(*)</code> searches aren't supported. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </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 that's associated with the group.