Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141784109.3 KB

Returns information about a specific group.

post/Groups/DescribeGroup#DirectoryId

Query parameters

DirectoryIdstring required

The Identifier (ID) of the directory associated with the group.

Request body

OtherAttributesLdapDisplayName[]

One or more attributes to be returned for the 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>.

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>
SAMAccountNamestring required

The name of the group.

Response

Success

DirectoryIdstring

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

DistinguishedNamestring password

The <a href="https://learn.microsoft.com/en-us/windows/win32/ad/object-names-and-identities#distinguished-name">distinguished name</a> of the object.

GroupScope'DomainLocal' | 'Global' | 'Universal' | 'BuiltinLocal'

The scope of the AD group. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#group-scope">Active Directory security groups</a>.

GroupType'Distribution' | 'Security'

The AD group type. For details, see <a href="https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-groups#how-active-directory-security-groups-work">Active Directory security group type</a>.

OtherAttributesobject

The attribute values that are returned for the attribute names that are included in the request.

Realmstring

The domain name that's associated with the group.

SAMAccountNamestring

The name of the group.

SIDstring

The unique security identifier (SID) of the group.