Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141784109.3 KB

Returns information about a specific user.

post/Users/DescribeUser#DirectoryId

Query parameters

DirectoryIdstring required

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

Request body

OtherAttributesLdapDisplayName[]

One or more attribute names to be returned for the user. A key is an attribute name, and the value is a list of maps. 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 user. </p> <note> <p> This parameter is optional, so you can return users outside your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD users are returned. </p> <p> This value is case insensitive. </p> </note>
SAMAccountNamestring required

The name of the user.

Response

Success

DirectoryIdstring

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

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.

EmailAddressstring password

The email address of the user.

Enabledboolean

Indicates whether the user account is active.

GivenNamestring password

The first name of the user.

OtherAttributesobject
<p> The attribute values that are returned for the attribute names that are included in the request. </p> <note> <p> Attribute names are case insensitive. </p> </note>
Realmstring

The domain name that's associated with the user.

SAMAccountNamestring

The name of the user.

SIDstring

The unique security identifier (SID) of the user.

Surnamestring password

The last name of the user.

UserPrincipalNamestring password

The UPN that is an Internet-style login name for a user and is based on the Internet standard <a href="https://datatracker.ietf.org/doc/html/rfc822">RFC 822</a>. The UPN is shorter than the distinguished name and easier to remember.