Skip to content

DescribeUserResult

Source code in docs_src/capo_directory_service_data/types/describe_user_result.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class DescribeUserResult(TypedDict, closed=True):
    directory_id: NotRequired[
        "capo_directory_service_data.types.directory_id.DirectoryId"
    ]
    """<p> The identifier (ID) of the directory that's associated with the user. </p>"""
    realm: NotRequired["capo_directory_service_data.types.realm.Realm"]
    """<p> The domain name that's associated with the user. </p>"""
    sid: NotRequired["capo_directory_service_data.types.sid.SID"]
    """<p> The unique security identifier (SID) of the user. </p>"""
    sam_account_name: NotRequired[
        "capo_directory_service_data.types.user_name.UserName"
    ]
    """<p> The name of the user. </p>"""
    distinguished_name: NotRequired[
        "capo_directory_service_data.types.distinguished_name.DistinguishedName"
    ]
    """<p> The <a href="https://learn.microsoft.com/en-us/windows/win32/ad/object-names-and-identities#distinguished-name">distinguished name</a> of the object. </p>"""
    user_principal_name: NotRequired[
        "capo_directory_service_data.types.user_principal_name.UserPrincipalName"
    ]
    """<p> 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. </p>"""
    email_address: NotRequired[
        "capo_directory_service_data.types.email_address.EmailAddress"
    ]
    """<p> The email address of the user. </p>"""
    given_name: NotRequired["capo_directory_service_data.types.given_name.GivenName"]
    """<p> The first name of the user. </p>"""
    surname: NotRequired["capo_directory_service_data.types.surname.Surname"]
    """<p> The last name of the user. </p>"""
    enabled: NotRequired["bool"]
    """<p> Indicates whether the user account is active. </p>"""
    other_attributes: NotRequired[
        "capo_directory_service_data.types.attributes.Attributes"
    ]
    """<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>"""

directory_id instance-attribute 

directory_id: NotRequired[DirectoryId]

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

distinguished_name instance-attribute 

distinguished_name: NotRequired[DistinguishedName]

The distinguished name of the object.

email_address instance-attribute 

email_address: NotRequired[EmailAddress]

The email address of the user.

enabled instance-attribute 

enabled: NotRequired[bool]

Indicates whether the user account is active.

given_name instance-attribute 

given_name: NotRequired[GivenName]

The first name of the user.

other_attributes instance-attribute 

other_attributes: NotRequired[Attributes]

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

Attribute names are case insensitive.

realm instance-attribute 

realm: NotRequired[Realm]

The domain name that's associated with the user.

sam_account_name instance-attribute 

sam_account_name: NotRequired[UserName]

The name of the user.

sid instance-attribute 

sid: NotRequired[SID]

The unique security identifier (SID) of the user.

surname instance-attribute 

surname: NotRequired[Surname]

The last name of the user.

user_principal_name instance-attribute 

user_principal_name: NotRequired[UserPrincipalName]

The UPN that is an Internet-style login name for a user and is based on the Internet standard RFC 822. The UPN is shorter than the distinguished name and easier to remember.